Prerequisites
Before you begin, make sure:- You have access to a public Zapier integration.
- You’ve registered your app and authenticated to use the API.
- You have at least one action configured in your integration, with required fields and sample data tested in the Zapier UI or via the API.
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
Parameters
Field | Type | Description |
---|---|---|
action | string | The unique identifier of the action you want to run. |
authentication | string | The authentication id needed to run this action. |
input | object | Key-value pairs of input fields required by the action. |
Response Example
id
to poll for the run’s status and result.