Trigger a workflow execution
Changed onWith an Idempotency-Key, a retry returns the accepted run's runId and skipped without starting, resuming or waiting for anything, even after the workflow was disabled or edited and whatever state the run is in now.
Request
- Base URLhttp://localhost:3013
- URLhttp://localhost:3013/api/workflows/{id}/trigger
- AuthHTTP bearer
Path parameters
Query parameters
Default true: respond after the run's instant steps ran, when it finishes or parks at its first async step. false: respond as soon as the run is committed and walk it in the background.
Headers
Optional client-generated key, 1-255 visible ASCII characters (a UUID works). The first request the server accepts under a key starts one run; a retry with the same key and an equivalent body gets that request's status and body back (with Idempotent-Replayed: true) and changes nothing. The key is scoped to the caller's identity and this operation; it is not a credential. The same key with a different body is a 409. A request rejected before it is accepted (validation, auth, not found, disabled) does not use up the key. Accepted keys do not expire.
Response
Workflow run started (or skipped if cooldown active)
Changes
- info
added the new optional
queryrequest parameterwait
- info
- info
added the new optional
headerrequest parameterIdempotency-Key - info
added the non-success response with the status
- info
added the non-success response with the status
- info