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/
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.