Creating Action Runs

Prerequisites

Before you begin, make sure:

• This endpoint requires either a public Zapier integration or white label API access.

---

To trigger an action, make a POST request to /v2/action-runs/

Important: Before every action run, for the action attribute on your request body you should retreive a new/unique id from the Get Actions endpoint for the action that you’d like to execute. This ensures that the action run can be uniquely tracked, that it can be properly debugged, and that attributions are properly reported.

Note: The id attribute will be unique for every lookup on the Get Actions endpoint, and the key attribute will be the action’s consistent developer-provided identifier.

Request Example

POST https://api.zapier.com/v2/action-runs/
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "data": {
    "action": "core:89sg4uhs5g85gh53hso59hs399hgs59",
    "authentication": "UHsi8e6K",
    "input": {
      "email": "[e-mail]",
      "message": "Hello from Powered by Zapier!"
    },
    "callback_url": "https://example.com/post_callback"
  }
}

Parameters

Field	Type	Required	Description
action	string	Yes	The unique identifier of the action you want to run.
authentication	string	Yes	The authentication id needed to run this action.
input	object	Yes	Key-value pairs of input fields required by the action.
callback_url	string	No	HTTPS URL to receive the result when the run completes. If omitted, poll for the result instead.

Response Example

{
  "data": {
    "type": "run",
    "id": "arun_abc123"
  }
}

You can use this run’s id to poll for the run’s status and result, or receive the result via callback if you included a callback_url.

At high volumes, use callback_url instead of polling. See Receiving Action Run Callbacks for details.