Skip to main content
Nango logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 24
  • Triggers: 0
  • Slug: NANGO
  • Version: 20261101_00

Tools

Slug: NANGO_ACTION_TRIGGER_POSTTrigger a Nango action to execute a workflow or operation. Use this to run pre-defined actions in your Nango integrations, such as creating issues, sending messages, or fetching data from external APIs. All three of connection_id, provider_config_key, and action_name must simultaneously match a pre-configured integration and connection in Nango — a valid connection_id alone is insufficient if the other two don’t correspond to an existing setup. Actions may have real upstream side effects (e.g., creating records, sending messages); confirm intent before triggering non-read-only operations.

Input Parameters

object
Optional input payload for the action’s exec function. The structure depends on the specific action being triggered.
string
required
The name of the action to trigger as defined in your Nango integration.
string
required
The connection identifier used when creating the connection in Nango.
string
required
The integration’s unique key (provider config key) in Nango.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_ADD_CONNECTIONTool to add a connection with existing credentials to Nango. Use when you want to bulk import existing access tokens into Nango.

Input Parameters

object
Connection tags as key/value string pairs. Keys are normalized to lowercase. Values max length is 255 chars.
object
End user information (deprecated, use tags instead).
object
Metadata to be attached to the connection (required for some OAuth APIs).
string
required
The credentials object with type-specific fields. Type field determines which credential schema to use.
string
The connection ID to use for this connection. If not provided, Nango will generate one.
object
Additional configuration to be attached to the connection (required for some OAuth APIs).
string
required
The integration ID that you created on Nango (also called provider config key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_CONNECTION_GETList Nango connections without credentials to discover connections, check status, and find connection IDs. Results can be filtered by connection ID, end user, organization, or search and retrieved by page.

Input Parameters

integer
Page number for paginated results.
integer
Maximum number of connections to return.
Search connections. Will partially match connection IDs or end user profiles.
string
Filter by exact end user ID.
string
Filter by exact connection ID. Can return multiple connections with the same ID across integrations.
string
Filter by exact end user organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_CREATE_CONNECT_SESSIONTool to create a new connect session with a 30-minute lifespan for enabling connection creation via Connect UI. Use when you need to generate a session token for users to authorize integrations through Nango’s Connect interface.

Input Parameters

object
Connection tags as key/value pairs. Keys are normalized to lowercase. Maximum value length is 255 characters.
object
required
End user information object. The ‘id’ field is required.
object
Override settings for integrations, keyed by integration unique name.
object
Organization information for the connect session.
array
List of integration IDs to filter which integrations the end user can interact with in the Connect UI.
object
Default configuration settings for integrations, keyed by integration unique name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_CREATE_INTEGRATIONTool to create a new integration in Nango. Use when setting up a new provider connection configuration. Creates an integration with specified credentials (OAuth2, App-based, or Hybrid authentication). The unique_key will be used to reference this integration in subsequent API calls. Returns the created integration details including timestamps and provider information.

Input Parameters

string
required
The provider unique name (e.g., github, slack, salesforce). Use List Providers to get valid provider names.
string
required
A unique integration ID, which you will use in other API calls to reference this integration. Must be unique across your Nango account.
string
Integration credentials for authentication. Schema varies by credential type: OAUTH2 requires client_id and client_secret; APP requires app_id, app_link, and private_key; HYBRID requires all fields.
string
Human-readable display name for the integration. If not provided, defaults to the provider name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_DELETE_CONNECTIONTool to delete a specific Nango connection. Use when you need to remove an existing connection permanently.

Input Parameters

string
required
The connection ID used to create the connection.
string
required
The integration ID used to create the connection (aka Unique Key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_DELETE_INTEGRATIONTool to delete a specific integration by its unique key. Use when you need to remove an integration configuration from Nango.

Input Parameters

string
required
The integration ID (unique_key) that you created in Nango.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_EDIT_CONNECTIONEdit a Nango connection’s tags or end user information, such as environment tags and team assignments.

Input Parameters

object
Connection tags (key/value strings). Keys are normalized to lowercase. Max value length: 255 characters.
object
End user information to update on the connection. Deprecated - use tags instead for new implementations.
string
required
The connection ID used to create the connection
string
required
The integration ID used to create the connection (aka Unique Key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_GET_CONNECTIONRetrieve a specific connection with its credentials. Automatically checks if the access token has expired and refreshes it if needed. Use this action when you need to access the authentication credentials for a connection to make API calls to the provider. The credentials returned depend on the auth type (OAuth2, API Key, Basic Auth, etc.). Returns 404 if the connection does not exist, 424 if token refresh is exhausted.

Input Parameters

string
required
The connection ID used to create the connection. This identifies the specific connection to retrieve.
boolean
If true, Nango will attempt to refresh the access token regardless of its expiration status. Default is false.
boolean
If true, return the refresh token as part of the response. Default is false.
string
required
The integration ID (Unique Key) used to create the connection. Required to identify which integration this connection belongs to.
boolean
If true, this will refresh the JWT token for GitHub App / GitHub App OAuth connections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_GET_ENVIRONMENT_VARIABLESTool to retrieve environment variables from the Nango dashboard. Use when you need to access or list environment variables configured in Nango.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_GET_INTEGRATIONRetrieve detailed configuration for a specific Nango integration by its unique key. Returns integration details including provider, display name, creation/update timestamps, and optionally sensitive data like credentials or webhook URLs if requested via the ‘include’ parameter. Use this to inspect integration configuration, verify setup, or retrieve credentials for a specific integration. Returns 404 error if the integration unique key does not exist.

Input Parameters

array
Optional list of additional sensitive data to include in the response (e.g., credentials, webhook_url).
string
required
The integration ID (unique_key) that you created in Nango. This is the identifier for your integration configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_GET_PROXYTool to make a GET request with Nango’s Proxy to forward requests to external APIs while managing authentication. Use when you need to make authenticated API calls to external services through Nango’s proxy infrastructure.

Input Parameters

integer
The number of retries in case of failure (with exponential back-off). Optional, default 0.
string
required
The path to the external API endpoint to proxy the request to (e.g., ‘users’, ‘repos/owner/repo’, ‘api/v2/tasks’). Do not include leading slash.
string
Comma separated status codes to explicitly retry on in addition to the default 5xx and 429.
boolean
Override the decompress option when making requests. Optional, defaults to false.
object
Optional query parameters to pass to the external API endpoint.
string
required
The connection ID used to create the connection in Nango.
object
Additional custom headers to pass to the external API. These will be prefixed with ‘nango-proxy-’ automatically.
string
Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden.
string
required
The integration ID used to create the connection (aka Unique Key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_GET_SYNC_STATUSTool to get the status of specified sync(s) for a connection or all connections. Use when you need to monitor sync execution state, check completion times, or view sync frequency.

Input Parameters

string
required
The name of the syncs you want to fetch a status for, as a comma-separated list. Pass in ”*” to return all syncs for the integration. For variants, use the format “syncName::variantName”.
string
The ID of the connection. If omitted, all connections will be surfaced.
string
required
The ID of the integration you established within Nango.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_LIST_CONNECTIONSTool to list all connections without credentials. Use when you need to retrieve connection metadata across your account.

Input Parameters

integer
Page number for paginated results.
object
Filter the list of connections based on connection tags. All provided tags must match.
integer
Limit the number of connections returned.
string
Will partially match connection IDs or end user profiles.
string
Deprecated. Prefer filtering connections by tag (e.g. tags[end_user_id]=…).
string
Will exactly match a given connectionId. Can return multiple connections with the same ID across integrations.
string
Deprecated. Prefer filtering connections by tag (e.g. tags[organization_id]=…).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_LIST_INTEGRATIONSTool to retrieve a list of all configured integrations. Use when you need to display or iterate through integrations in your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_PROVIDERS_GET_GETRetrieve detailed configuration for a specific Nango provider by its unique key. Returns provider authentication details (auth_mode, OAuth URLs), proxy configuration, required credentials schema, and connection configuration requirements. Use this to understand how to set up a connection with a specific provider or to get its documentation links. Provider keys can be obtained from the List Providers action. Returns 404 error if provider key does not exist.

Input Parameters

string
required
The unique provider key/slug (lowercase with hyphens). Use the ‘name’ field from List Providers to get valid keys. Examples: ‘github’, ‘salesforce’, ‘active-campaign’, ‘hubspot’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_PROVIDERS_LIST_GETRetrieve a list of available Nango providers for display or discovery before creating connections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_PUT_PROXYTool to make a PUT request with the Nango Proxy to forward requests to external APIs while managing authentication. Use when you need to update resources via external APIs through Nango’s proxy.

Input Parameters

object
The request body to send to the external API. All body parameters are passed through to the external API.
string
The number of retries in case of failure (with exponential back-off). Default is 0.
string
required
The API path to send the PUT request to (e.g., ‘/users/123’, ‘/items/update’). This path will be appended to the base URL of the external API.
string
Override the decompress option when making requests. Defaults to false.
string
required
The connection ID used to create the connection.
string
Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden.
object
Additional headers to pass on to the external API. These will be prefixed with ‘nango-proxy-’ automatically.
string
required
The integration ID used to create the connection (aka Unique Key).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_RECONNECT_SESSION_POSTCreate a new connect session to reconnect to a specific integration. Use this when a user needs to input new credentials or to manually refresh a token. Only connections created with a connect session are compatible with this endpoint.

Input Parameters

object
Connection tags (key/value strings). Keys are normalized to lowercase.
object
End user information for the connection.
object
Override configuration for integrations by integration name
object
Organization information for the end user (deprecated, use tags instead).
string
required
The connection ID to reconnect. Only connections created with a connect session are compatible with this endpoint.
string
required
The integration ID (provider config key) for the connection
object
Default configuration for integrations by integration name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_SCRIPTS_CONFIG_GETRetrieve all integration functions configuration from Nango. Returns the configuration for all integrations including their sync scripts, action scripts, and event handlers. Use this to discover available integrations and their capabilities before triggering syncs or actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_SET_CONNECTION_METADATATool to set custom metadata for one or more Nango connections. Use when you need to attach custom data (tags, labels, context) to connections for filtering, organization, or application-specific purposes.

Input Parameters

object
required
Custom metadata object to set for the connection(s). Can contain string, number, boolean, or null values.
string
required
The connection ID or array of connection IDs to update. Pass a single string to update one connection, or an array of strings to update multiple connections.
string
required
The integration’s unique key (provider config key) used to create the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_SYNC_TRIGGER_POSTTool to trigger sync process(es) manually. Use after establishing a connection and defining syncs. This triggers an additional, one-off execution of the specified sync(s) for a given connection or all applicable connections. Useful when you changed metadata for a connection and want to re-import data.

Input Parameters

array
required
List of sync names to trigger. Use an empty list [] to trigger all syncs for the integration.
string ("incremental" | "full_refresh" | "full_refresh_and_clear_cache")
Execution mode for the sync trigger.
string
The ID of the specific connection. If omitted, the syncs will be triggered for all relevant connections under the integration.
string
required
The ID of the integration (provider configuration) established within Nango. This is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_UPDATE_CONNECTION_METADATATool to edit custom metadata for one or multiple connections. Use when you need to update specific metadata properties without overwriting the entire metadata object.

Input Parameters

object
required
The metadata properties to update. Only specified properties will be overridden; existing properties not included will remain unchanged.
string
required
The connection ID or array of connection IDs to update. Use a single string for one connection or a list of strings for multiple connections.
string
required
The integration ID (unique key) used to create the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NANGO_UPDATE_INTEGRATIONTool to update an existing integration’s configuration. Use when you need to modify an integration’s display name, unique key, or credentials.

Input Parameters

string
required
The integration ID (unique_key) that you created in Nango
string
Integration credentials schema for different authentication types. Provide one of: OAuth2Credentials, AppCredentials, or HybridAppCredentials
string
The integration display name
string
New unique integration ID if you want to rename the integration key

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not