API configuration (`providers.yaml`)

API configurations are listed in the providers.yaml file, located in the Nango GitHub repository.

Examples

hubspot:
    display_name: HubSpot
    categories:
        - marketing
        - support
        - crm
    auth_mode: OAUTH2
    authorization_url: https://app.hubspot.com/oauth/authorize
    token_url: https://api.hubapi.com/oauth/v1/token
    connection_configuration:
        - portalId
    post_connection_script: hubspotPostConnection
    webhook_routing_script: hubspotWebhookRouting
    proxy:
        base_url: https://api.hubapi.com
        decompress: true
        paginate:
            type: cursor
            cursor_path_in_response: paging.next.after
            limit_name_in_request: limit
            cursor_name_in_request: after
            response_path: results
    docs: https://nango.dev/docs/api-integrations/hubspot

salesforce:
    display_name: Salesforce
    categories:
        - crm
    auth_mode: OAUTH2
    authorization_url: https://login.salesforce.com/services/oauth2/authorize
    token_url: https://login.salesforce.com/services/oauth2/token
    authorization_params:
        prompt: consent
    default_scopes:
        - offline_access
    token_response_metadata:
        - instance_url
    proxy:
        base_url: ${connectionConfig.instance_url}
    webhook_routing_script: salesforceWebhookRouting
    post_connection_script: salesforcePostConnection
    docs: https://nango.dev/docs/api-integrations/salesforce
    connection_config:
        instance_url:
            type: string
            title: Instance URL
            description: The instance URL of your Salesforce account
            format: uri
            pattern: '^https?://.*$'

google:
    display_name: Google
    auth_mode: OAUTH2
    authorization_url: https://accounts.google.com/o/oauth2/v2/auth
    token_url: https://oauth2.googleapis.com/token
    authorization_params:
        response_type: code
        access_type: offline
        prompt: consent
    proxy:
        base_url: https://www.googleapis.com
        paginate:
            type: cursor
            cursor_path_in_response: nextPageToken
            limit_name_in_request: maxSize
            cursor_name_in_request: pageToken
            response_path: items
    docs: https://nango.dev/docs/api-integrations/google

notion:
    display_name: Notion
    categories:
        - knowledge-base
        - productivity
    auth_mode: OAUTH2
    authorization_url: https://api.notion.com/v1/oauth/authorize
    token_url: https://api.notion.com/v1/oauth/token
    authorization_params:
        response_type: code
        owner: user
    authorization_method: header
    body_format: json
    proxy:
        retry:
            after: 'Retry-After'
        base_url: https://api.notion.com
        headers:
            'Notion-Version': '2022-06-28'
        paginate:
            type: cursor
            cursor_path_in_response: next_cursor
            cursor_name_in_request: start_cursor
            limit_name_in_request: page_size
            response_path: results
    docs: https://nango.dev/docs/api-integrations/notion

linear:
    display_name: Linear
    categories:
        - productivity
        - ticketing
    auth_mode: OAUTH2
    authorization_url: https://linear.app/oauth/authorize
    token_url: https://api.linear.app/oauth/token
    scope_separator: ','
    authorization_params:
        prompt: consent
    proxy:
        base_url: https://api.linear.app
    disable_pkce: true
    webhook_routing_script: linearWebhookRouting
    post_connection_script: linearPostConnection
    webhook_user_defined_secret: true
    docs: https://nango.dev/docs/api-integrations/linear

slack:
    display_name: Slack
    categories:
        - productivity
    auth_mode: OAUTH2
    authorization_url: https://slack.com/oauth/v2/authorize
    token_url: https://slack.com/api/oauth.v2.access
    token_response_metadata:
        - incoming_webhook.url
        - incoming_webhook.channel
        - incoming_webhook.channel_id
        - bot_user_id
        - team.id
    proxy:
        base_url: https://slack.com/api
        paginate:
            type: cursor
            cursor_path_in_response: response_metadata.next_cursor
            cursor_name_in_request: cursor
            limit_name_in_request: limit
    webhook_routing_script: slackWebhookRouting
    docs: https://nango.dev/docs/api-integrations/slack

All configuration fields

Looking for the JSON Schema, find it in our GitHub

string

Allows to extend the configuration of another API.

string

required

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

string

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

object

Authentication configuration.

Show child attributes

string

The response type for authentication.

string

The authorization method. Must be header

object

Query parameters of the authorization request.

Show child attributes

string

Possible value: “offline”

string

Possible values: “auto”, “force”

string

Possible value: “permanent”

string

Possible value: “never”

boolean

Whether to force verification

string

A unique string to be included in the request

string

Possible value: “consent”

string

The mode of the response

string

The type of the response

string

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

boolean

Should the authorization_url be encoded or not

object

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

string

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

array

An array of strings representing the categories of the API.

array

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

boolean

Whether to decode the URL or not.

array

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

boolean

Disables the PKCE extension to the Authorization Code flow.

string

The URL to the developer API documentation.

string

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

string

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

object

Proxy configuration for the API.

Show child attributes

string

The base URL for the API.

boolean

Whether to decompress the response.

object

Headers to be sent with each request.

object

Pagination configuration.

Show child attributes

string

The name of the cursor parameter in the request.

string

The path to the cursor value in the response.

string

The name of the limit parameter in the request.

string

The rel attribute of the link header for pagination.

string

The path to the link in the response body.

string

The name of the offset parameter in the request.

string

The method to calculate the offset in the request. Must be one of: “per-page” or “by-response-size”. Optional parameter that defaults to “by-response-size”.

number

The starting value for the offset.

string

The path to the paginated data in the response.

string

The type of pagination. Must be one of: “link”, “cursor”, “offset”.

object

Query parameters to be sent with each request.

object

Retry configuration.

Show child attributes

string

The name of the rate-limit header, e.g. after: 'X-Rate-Limit-Reset'

string

The name of the rate-limit header, e.g. at: 'x-ratelimit-reset'

object

required

Configure a HTTP call to verify if credentials are valid, only used for API Key and Basic auth.

Show child attributes

string

The HTTP method for verification. Must be either “GET” or “POST”.

string

required

The endpoint for verification.

string

Override the base URL for verification.

object

Headers for the verification request.

array

The metadata to capture from the callback request.

string

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

object

Parameters used for refreshing the access token.

Show child attributes

string

The grant type for refreshing the token. Must be “refresh_token”.

object

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

string

The URL for making API an authorization request.

string

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

string

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

number

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

object

Parameters used for obtaining the access token.

Show child attributes

string

The grant type for obtaining the token. Must be either “authorization_code” or “client_credentials”.

string

Additional request information for obtaining the token.

string

The authentication method used for token requests: “basic”, “custom”, “private_key_jwt”, or “none”. Use “none” for public clients that send only their client_id, with no client secret.

string

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

array

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

string

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

boolean

Should the token_url be encoded or not

boolean

Wether the webhook secret is set by the user.

array

Specifies a script to handle external webhooks.

string

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.

object

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

Show child attributes

object

Show child attributes

string

required

The type of this value. Must be “string”.

string

required

The title of this value.

string

required

The description of this value.

string

An example of valid value to display in a UI.

string

A regex pattern for the credential.

string

The special format of this value (e.g: hostname, uri)

number

The order in which this field should be displayed in a UI

string

The documentation section relative to docs_connect

object

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

Show child attributes

object

Show child attributes

string

required

The type of the credential. Must be “string”.

string

required

The title of the credential.

string

required

The description of the credential.

string

An example of the credential.

string

A pattern for the credential.

string

The format of the credential.

string

The documentation section for the credential.

Questions, problems, feedback? Please reach out in the Slack community.

Overview

1,000+ APIs & Integrations

API configuration (`providers.yaml`)

Examples

All configuration fields