API configuration (providers.yaml)
API configurations are listed in the providers.yaml
file, located in the Nango GitHub repository. Learn more about API configurations.
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://docs.nango.dev/integrations/all/hubspot
All configuration fields
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”.
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.
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)
Questions, problems, feedback? Please reach out in the Slack community.
Was this page helpful?