playbooks

Run Playbook

Changed on

Manually trigger a run for a manual-trigger playbook.

Requires the sequences:write scope on the API key.

post/v1/playbooks/{playbook_id}/run

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/playbooks/{playbook_id}/run
  • Auth: HTTP bearer

Path parameters

playbook_idstring uuid required

ID of the playbook.

Request body

trigger_payloadobject

Optional trigger context passed into the run.

dry_runboolean

When true, execute without side effects where supported.

Response

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' | 'CANCELLED' required
deduplicatedboolean required

Whether this run deduplicated against an already active execution.

Changes