Custom Integrations (v2)

How to Add a Custom Integration in Rewst

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

Steps

Click on Configuration -> Integrations.

Click on Add New Integration.

  • Click on New Integration to build your integration from the beginning.

  • Alternatively, click on 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).

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

Specify your Configuration details, then click on Next.

Add a name for your integration, a logo (SVG only), and a description.

Choose your authentication method, then click on Next.

Add the hostname without "https://", and select an authentication method. Rewst supports:

  • API Key

  • Basic Auth

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

  • No Auth

Fill out the authentication defaults, then click on Next

Depending on the auth method you chose, you will be presented with a form to fill out the details of the integrations authentication.

Fill out the authentication defaults, then click on Next

Select a pagination method, then click on Next

Select from:

  • No pagination

  • Index

  • Page

  • Link

  • Pointer

Select a pagination method, then click on Next

Fill out the pagination details, then click on Next

Depending on the pagination method you chose, you will be presented with a form to fill out the details of the integrations pagination.

Fill out the pagination details, then click on Next

Edit your actions, then click on Finalize

On this step you will create, update, or delete the actions and their parameters

Edit your actions, then click on Finalize

Click on Finalize again.

Click on Finalize

(Optional) Update the status of your integration.

Select one of:

  • 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.

(Optional) Update the status of your integration.

Last updated