Create an Action Run

Runs an action (step) in the third party API, using the provided authentication and inputs.

This endpoint is asynchronous, and the response will contain an Action Run ID. You can use the /v2/action-runs/:id endpoint to check the status of the run and retrieve the results.

Optionally, include a callback_url in the request body to receive the result via a POST callback instead of polling.

When using OAuth

This endpoint requires the action:run OAuth scope.

POST /v2/action-runs

Create an Action Run

cURL

curl --request POST \
  --url https://api.zapier.com/v2/action-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "action": "example_core:Vn7xbE60",
    "authentication": "example_QVaAreV1",
    "inputs": {
      "email": "[e-mail]"
    }
  }
}
'

200

{
  "data": {
    "type": "run",
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Running actions via the Workflow API is currently in limited beta. If you would like access to run actions, please contact [e-mail] to request access.

This API is rate limited.

Authorizations

Authorization · string · header · required

See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication

Body

application/json

data · object · required

Data for the Action Run

Show child attributes

Callbacks

POST

{$request.body#/data/callback_url}actionRunCompleted

Body

application/json

Shape of the POST body Zapier sends to the partner's callback_url on run completion. Matches the polling response shape with the addition of id.

data · object · required

The status of the Action Run.

Show child attributes

Response

2XX

Callback acknowledged

Response

200

application/json

data · object · required

The response after an Action Run

Show child attributes