Skip to main content

Providers

This guide explains how to add a Custom Provider to use in the Flow Builder. Providers are essentially API endpoints that include base settings for the connection, such as authentication, base URL, headers, and more.

warning

Custom Providers and Actions are managed on the Workspace level. Changes affect all Apps within your Workspace as soon as they are republished.

Add a Custom Provider​

  1. Navigate to either the Flow Builder's Triggers or Actions tab, scroll down to Provider Triggers/Actions.
  2. Click on + to open the Provider settings dialog.

Add a Custom Provider

Basic Information​

  • Name: Enter the name of the Provider (e.g., Slack).
  • Category: Select a category that best fits the Provider’s functionality.
  • Description (optional): Provide a brief description, such as "Slack REST API".

Visual Customization​

  • Logo: Upload a logo for the Provider by clicking Upload. Ensure the image is within the size limit of 2MB.
  • Color: Choose the color the Provider's Actions will be highlighted with or click Random to auto-select one.

API Configuration​

  • Type: Select the type of API (e.g., REST or GraphQL).
  • Base URL: Enter the Provider's base API URL (e.g., https://slack.com/api).

You can also use Provider parameters and variables in the Base URL (e.g., https://{$datacenter}.api.mailchimp.com).

Best Practice: Do not include API versions in the Base URL (e.g., https://slack.com/api/v1). You might want to update the API version individually on an Action basis later on.

Authorization Settings​

  • Type: Choose the authorization method (e.g., API Key, Bearer Token, etc.).

Each type has its own sub-settings.

Headers​

  • Click Add Header to specify any additional headers required by the Provider.

Configure Rate Limiting​

  • Retry After (in seconds): Enter the time interval before retrying a failed request.
  • Status Code: Enter the status code that indicates rate limiting (e.g., 429).

Error Keys​

  • Click on Add Key to map error keys and specify where to find them in the response (e.g., “error” key in the Body).

Parameters​

Parameters will be available as Connection settings. You will need parameters for Providers with multiple connections wherever a user-specific value is needed in the URL or path of the API request. For example, the Mailchimp API URL contains the Datacenter which is different for every user (https://{$datacenter}.api.mailchimp.com). Parameters can be used within Base URLs and within your custom Provider Actions.

Add any necessary parameters by clicking Add Parameter and defining the name, type and an optional description.

Variables​

Variables can be helpful for multiple uses of the same values within your Actions. You can set and update the values globally in the Provider settings and use them within Base URLs and your custom Provider Actions.

Click Add Variable to define any variables needed for the API integration.

Save & Publish​

Once all configurations are complete, click Save to finalize adding your Provider. Note that your new settings will only take effect when you republish your Apps.

info

Note that to use a Provider and its Actions, you must first establish a connection. To do so, navigate to the desired Provider in either the Triggers or Actions tab, click Connections, and create a new connection.

Save & Publish Custom Provider