Rest API

You can connect to your REST API to request data and interact with 3rd party services or even your own backend. This allows you to combine data with your other data sources and trigger operations based on data of other data source.

Connecting to your REST API

To connect your REST API, follow the steps below:

  1. Go to Data Management and click on "New source" to create a new data source.

  2. Select REST API from the list of available data sources.

  3. Name your data source connection and provide the connection details:


Base url

The base url where the API endpoints are placed. You can also provide the entire url for the endpoint if you want to create one data source for each endpoint.


Length until request times out (to avoid infinitely long requests).


Parameters that are passed along with the request.


Headers that are passed along with the request. Especially useful for authentication headers for simple authentication via bearer token.

(optional) OAuth 2.0 Authentication

  • Token url: Url from which to request the access token.

  • Client ID & Secret: Client credentials (API key and secret) sent as part of the authorization header.

  • Scope: The access scope that you want to request.

  • Audience: Defines the endpoints at which the token can be used.

  1. Click on "Test connection" to ensure that your connection works reliably and save your data source connection with "Connect".

Note: You can configure the data source for two different environments, Staging and Production. You can find more information about it here.

Last updated