POST
/
action
/
trigger
cURL
curl --request POST \
  --url https://api.nango.dev/action/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Id: <connection-id>' \
  --header 'Content-Type: application/json' \
  --header 'Provider-Config-Key: <provider-config-key>' \
  --data '{
  "action_name": "<string>",
  "input": {}
}'
{
  "your-properties": "The data returned by the action"
}

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Headers

​
Connection-Id
string
required

The connection ID used to create the connection.

​
Provider-Config-Key
string
required

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

​
X-Async
boolean

Set to true to trigger the action asynchronously. When true, the response will include a status URL and ID for retrieving the action result later. See Asynchronous action documentation for more details.

​
X-Max-Retries
integer
default:0

The maximum number of retries in case of failure (between 0 and 5). Only applicable when X-Async is true. Default to 0 if not specified.

Required range: 0 <= x <= 5

Body

application/json
​
action_name
string
required

The name of the action to trigger.

​
input
object

The necessary input for your action's 'exec' function.

Response

The result of the action.

The result of the action when triggered synchronously. (cannot exceed 10MB)

​
your-properties
object

The data returned by the action

Example:

"The data returned by the action"