playbooks

Run Playbook

Manually trigger a run for a manual-trigger playbook.

Requires the sequences:write scope on the API key.

post/v1/playbooks/{playbook_id}/run

Path parameters

playbook_idstring uuid required

ID of the playbook.

trigger_payloadobject

Optional trigger context passed into the run.

dry_runboolean

When true, execute without side effects where supported.

Successful Response

run_idstring uuid required

Unique identifier of the started run.

playbook_idstring uuid required

Playbook that was run.

workflow_idstring required

Temporal workflow execution ID.

status'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'REJECTED' required

deduplicatedboolean required

Whether this run deduplicated against an already active execution.