Build Integrations - Reference
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:
categories:
- marketing
- support
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: hubspot-post-connection
webhook_routing_script: hubspot-webhook-routing
proxy:
base_url: https://api.hubapi.com
decompress: true
docs: https://docs.nango.dev/integrations/all/hubspot
All configuration fields
Field | Description |
---|---|
auth_mode | The type of authorization of the API, e.g. OAUTH2 , API_KEY , BASIC , etc. |
authorization_url | The URL to show the OAuth 2 login form to authorize the external service. |
token_url | The URL to get the OAuth 2 credentials from the external API. |
scope_separator | Defaults to space, but some APIs sur , or + . |
authorization_params | Query parameters of the authorization request, e.g. response_type: code |
token_params | Query parameters of the token request, e.g. grant_type: authorization_code |
refresh_params | Query parameters of the refresh request, e.g. grant_type: refresh_token |
proxy | Contains the configuration to use the proxy. |
proxy.base_url | The base URL of the API to be used when proxying requests. |
proxy.headers | The headers to include when proxying requests. |
proxy.retry.after | The name of the rate-limit header, e.g. after: 'X-Rate-Limit-Reset' |
proxy.retry.at | The name of the rate-limit header, e.g. at: 'x-ratelimit-reset' |
docs | The link to the API documentation (in the Nango documentation). |
default_scopes | The minimum list of scopes that are necessary to connect to the API. |
refresh_url | The URL to refresh the OAuth credentials (defaults to the token_url ) |
disable_pkce | Disables the PKCE extention to the Authorization Code flow. |
token_request_auth_method | The authorization method for the token request. |
token_response_metadata | The metadata to capture from the token response. |
webhook_routing_script | Specifies a script to handle external webhooks. |
post_connection_script | Specifies a script to execute following each new connection. |
request_url | The token request URL for OAuth 1. |
signature_method | The signature method for OAuth 1 |
redirect_uri_metadata | The metadata to capture from the callback request. |
verification | The endpoint to verify that API key and Basic credentials are valid. |
categories | The categories of the external API (e.g. CRM) for proper documentation. |
alias | Allows to extend the configuration of another API. |
token_expiration_buffer | The buffer between when access token expiration and refresh. |
Questions, problems, feedback? Please reach out in the Slack community.
Was this page helpful?