run_id
that you can use to check the run’s status and result.
See a walkthrough of how to run one-off actions using the WorkflowAPI.
POST
request to /v2/action-runs/
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.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. |
id
to poll for the run’s status and result.
GET
request to /v2/action-runs/
Status | Meaning |
---|---|
queued | The run is waiting to be processed. |
running | The action is currently being executed. |
success | The run completed successfully. |
error | An error occurred while executing the run. |
results
field will contain the result of the action. You can surface this directly to the user or trigger a follow-up process.