Custom integrations (v2)

For more on custom integrations in Rewst, see our introductory documentation here.

Note that this is V2 of our custom integrations feature. Customers who previously installed V1 of custom integrations may find that setup documentation here.

This Integration supports multiple instances

Check out our instructions to set up multiple instances here.

Add a Custom Integration in Rewst

This guide will walk you through the steps to add a custom integration in Rewst.

Steps

1. Navigate to Configuration > Integrations in the left side menu of your Rewst platform.

1. Click Add New Integration.

   1. Click New Integration to build your integration from the beginning.

   2. Alternatively, click Add OpenAPI Integration if you have a JSON file that follows the OpenAPI or Swagger specification.

Note that Rewst will automatically convert Swagger to OpenAPI if necessary, and validate the API specification using the vacuum linting tool. Currently, only JSON files are accepted, not YAML.

1. Click Submit. Once you upload your file and there are no validation errors, you can start configuring your integration.

1. Specify your configuration details, then click Next.

2. Add a Name for your integration.

3. Upload an Icon via an SVG file. Other image file formats will not upload into Rewst.

4. Add a Description.

1. Choose your authentication method, then click Next.

2. Add the hostname without https:// at the beginning of your URL.

3. Choose an authentication method. Rewst supports:

• API Key

• Basic Auth

• OAuth 2.0 (Authorization code, Client Credentials, or no grant type)

• No Auth

Choose your authentication method, then click on Next

1. Fill out the authentication defaults, then click Next.

2. Depending on the authentication method you chose, you'll be presented with a form to fill out the details of the integration's authentication.

Fill out the authentication defaults, then click Next

1. Select a pagination method, then click Next.

2. Select your Pagination Type from the drop down menu:

• No pagination

• Index

• Page

• Link

• Pointer

Select a pagination method, then click on Next

1. Fill out the pagination details, then click Next.

2. Depending on the pagination method you chose, you'll be presented with a form to fill out the details of the integration's pagination.

Fill out the pagination details, then click on Next

1. Edit your actions, then click Finalize.

2. Create, update, or delete the actions and their parameters.

Edit your actions, then click on Finalize

1. Click Finalize again.

Click on Finalize

1. An optional step is to update the status of your integration. Select a status from the status list:

• Draft: The integration is not finalized, can be still be edited, but not installed. Once an integration is finalized it can't be put back in to draft mode.

• Published: The integration will be installable by your organizations and all sub organizations.

• Hidden: The integration is not installable by your organizations and all sub organizations, but can be edited.

Optionally, update the status of your integration.