Run now
Queue a run of an automation now. The answer comes at once (202) with the run, queued; follow it with
Get run. Running a draft switches it on (active).
Send an idempotency_key of at least 8 characters, new for each run you mean, and one across all your
organisation’s automations: the same key returns the same run, so a request you retry after a timeout never
starts two runs, and a key already used for another of your automations is refused with 422. mode: test
runs for real but refuses every change to your store, so you can see what a run would do.
Answers 409 wrong_state when the automation is archived, or starts when its store sends an event (it has
no Run now), and 422 when it cannot run yet: the store, or an account it reads, is not connected, or a step
of an imported workflow needs a connection (steps_unconfigured) or cannot run (step_unsupported). The
message says what to do. A connection a template needs beside its store is checked as the run starts: without
it the run ends refused (connection_missing), saying what to connect.
Needs the automations:write scope.
Authorizations
A bearer token from Login, sent as Authorization: Bearer <token>. Valid for 60 minutes; it acts as the person named at login, within their organisation, and never approves. Rotating or disabling the organisation's API credential ends every token made with it on its next call. See Authentication.
Path Parameters
The automation's id. A public id (a ULID).
^[0-9A-HJKMNP-TV-Z]{26}$Body
A key you make, at least 8 characters, new for each run you mean, and one across all your organisation's automations: the same key returns the same run, and one already used for another automation is refused.
8 - 64normal, or test: reads are real and every change to your store is refused.
normal, test