Allows to extend the configuration of another API.

The display name of the provider, used in the UI.

The authentication mode. Must be one of: “API_KEY”, “APP”, “APP_STORE”, “BASIC”, “NONE”, “OAUTH1”, “OAUTH2”, “OAUTH2_CC”, “CUSTOM”, “TBA”, “TABLEAU”, “JWT”, “BILL”, “TWO_STEP”, “SIGNATURE”.

Authentication configuration.

The authorization method. Must be header

Query parameters of the authorization request.

The URL to get the OAuth 2 credentials from the external API.

Should the authorization_url be encoded or not

An object containing key-value pairs for replacements in the authorization URL.

The format of the request body. e.g: json

An array of strings representing the categories of the API.

An array of strings representing the connectionConfig that are automatically populated by post-connection scripts.

Whether to decode the URL or not.

The minimum list of scopes that are necessary to connect to the API.

Disables the PKCE extention to the Authorization Code flow.

The URL to the developper API documentation.

The URL to the end user documentation (e.g: how to connect).

The name of the script to run after a connection is established.

Proxy configuration for the API.

The metadata to capture from the callback request.

The URL used for refreshing the access token. Defaults to the token_url

Parameters used for refreshing the access token.

An object containing request parameters to pass to an authorization request.

The URL for making API an authorization request.

The separator used between scopes in the authorization request. Defaults to space, but some APIs sur , or +.

The signature method used for OAuth 1.0. Must be either “HMAC-SHA1” or “PLAINTEXT”.

A buffer time (in seconds) before the token expiration to trigger a refresh.

Parameters used for obtaining the access token.

The authentication method used for token requests. Must be either “basic” or “custom”.

The unit of time for token expiration. Must be “milliseconds”.

An array of strings representing metadata from the token response that will be saved in connection.metadata.

The URL to get the OAuth 2 credentials from the external API.

Should the token_url be encoded or not

Wether the webhook secret is set by the user.

Specifies a script to handle external webhooks.

Specifies a fragment to be appended to the authorization URL, typically used to modify the redirection flow or pass additional information in the URL before the query parameters.

The list of properties available in ${connectionConfig} and their validation.

The list of credentials and their validation, only filed if necessary (e.g: API_KEY, BASIC)