Sign in
v1
protected
triggers

Run Trigger Now

Fire a trigger once, now, because a person asked for it.

Distinct from /execute, which replays a real event: this carries no event data and records the caller in fired_by, so the run is visibly a manual one and the task it creates belongs to the caller rather than to whoever created the trigger.

The run is otherwise faithful to a real one -- the trigger's conditions are still evaluated, and a run they reject comes back skipped with the reason rather than being forced through. A trigger that is switched off still runs: is_active governs the schedule, not a person asking for one run.

Returns: The execution, and the task id to watch when one was created.

post/v1/workspaces/{workspace}/triggers/{trigger_id}/run

Path parameters

trigger_idstring uuid required
workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Response

Successful Response

execution_idstring uuid required
reasonstring nullable

Why the run was skipped, when it was.

status'started' | 'skipped' required

'started' when a task was created and is now running. 'skipped' when the trigger's own conditions rejected the run -- a real answer about the trigger, not an error.

task_idstring uuid nullable

The task to watch. Absent when the run was skipped.

trigger_idstring uuid required

Changes

Changed in 1 of the 45 revisions of this API.1