Automations
Automations, their runs, and starting them by hand.
/v1/automationsList automations
Automations you can see: org-wide ones and those in your projects. Pass project_id for one project's.
automations:readMCP tool list_automationsQuery parameters
project_idstring or nullOnly this project's automations
Response
datalist of AutomationRequired
curl "https://developers.playbookops.ai/v1/automations" \
-H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"{
"data": [
{
"id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"title": "Call the venue",
"description": "Confirm the date and ask about parking.",
"project_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"project_title": "Spring launch",
"app_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"is_on": false,
"trigger": "When an item moves to Won",
"summary": "When an item moves to Won, email the client and create an onboarding task.",
"startable": false,
"needs_item": false,
"published_version": 0,
"last_run_at": "2026-11-21T15:04:05Z",
"url": "https://app.playbookops.ai/…"
}
]
}/v1/automations/{automation_id}Get an automation
One automation: what starts it, what it does in one sentence, and whether it's on.
automations:readMCP tool get_automationPath parameters
automation_idstringRequired
Response
idstringRequiredtitlestringRequireddescriptionstring or nullproject_idstring or nullproject_titlestring or nullapp_idstring or nullis_onbooleanRequiredtriggerstring or nullWhat starts it, in words
summarystring or nullThe whole automation as one sentence
startablebooleanRequiredPublished, on and started by hand
needs_itembooleanDefault false.
published_versioninteger or nulllast_run_atstring (date and time) or nullurlstringRequired
curl "https://developers.playbookops.ai/v1/automations/AUTOMATION_ID" \
-H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"{
"id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"title": "Call the venue",
"description": "Confirm the date and ask about parking.",
"project_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"project_title": "Spring launch",
"app_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"is_on": false,
"trigger": "When an item moves to Won",
"summary": "When an item moves to Won, email the client and create an onboarding task.",
"startable": false,
"needs_item": false,
"published_version": 0,
"last_run_at": "2026-11-21T15:04:05Z",
"url": "https://app.playbookops.ai/…"
}/v1/automations/{automation_id}/runsList an automation's runs
An automation's most recent runs, newest first, with their status and any error.
automations:readMCP tool list_automation_runsPath parameters
automation_idstringRequired
Query parameters
limitinteger1–200, default 25.
Response
datalist of AutomationRunRequired
curl "https://developers.playbookops.ai/v1/automations/AUTOMATION_ID/runs?limit=10" \
-H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"{
"data": [
{
"id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"automation_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"automation_title": "Welcome new clients",
"status": "in_progress",
"trigger_type": "…",
"item_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"item_title": "Call the venue",
"project_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"record_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"error": "…",
"is_test": false,
"started_at": "2026-11-21T15:04:05Z",
"finished_at": "2026-11-21T15:04:05Z"
}
]
}/v1/automation-runs/{run_id}Get a run
One run with each step it took, in order, and where it stopped or failed.
automations:readMCP tool get_automation_runPath parameters
run_idstringRequired
Response
idstringRequiredautomation_idstringRequiredautomation_titlestring or nullstatusstringRequiredtrigger_typestringRequireditem_idstring or nullitem_titlestring or nullproject_idstring or nullrecord_idstring or nullerrorstring or nullis_testbooleanDefault false.
started_atstring (date and time)Requiredfinished_atstring (date and time) or nullstepslist of RunStepRequired
curl "https://developers.playbookops.ai/v1/automation-runs/RUN_ID" \
-H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"{
"id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"automation_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"automation_title": "Welcome new clients",
"status": "in_progress",
"trigger_type": "…",
"item_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"item_title": "Call the venue",
"project_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"record_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"error": "…",
"is_test": false,
"started_at": "2026-11-21T15:04:05Z",
"finished_at": "2026-11-21T15:04:05Z",
"steps": [
{
"node_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"type": "…",
"status": "in_progress",
"error": "…",
"started_at": "2026-11-21T15:04:05Z",
"finished_at": "2026-11-21T15:04:05Z"
}
]
}/v1/automations/{automation_id}/runsStart an automation
Start an automation that's started by hand (its trigger is Manual). Returns the run; poll get_automation_run for progress.
automations:writeChanges data · supports Idempotency-KeyMCP tool start_automationPath parameters
automation_idstringRequired
Body
item_idstring or nullThe item to run it on, when the automation needs one
record_idstring or nullFor an app's automation: the Live record to run it on, when it needs one
Response
idstringRequiredautomation_idstringRequiredautomation_titlestring or nullstatusstringRequiredtrigger_typestringRequireditem_idstring or nullitem_titlestring or nullproject_idstring or nullrecord_idstring or nullerrorstring or nullis_testbooleanDefault false.
started_atstring (date and time)Requiredfinished_atstring (date and time) or nullstepslist of RunStepRequired
curl -X POST "https://developers.playbookops.ai/v1/automations/AUTOMATION_ID/runs" \
-H "Authorization: Bearer $PLAYBOOKOPS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"item_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"record_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42"
}'{
"id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"automation_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"automation_title": "Welcome new clients",
"status": "in_progress",
"trigger_type": "…",
"item_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"item_title": "Call the venue",
"project_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"record_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"error": "…",
"is_test": false,
"started_at": "2026-11-21T15:04:05Z",
"finished_at": "2026-11-21T15:04:05Z",
"steps": [
{
"node_id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
"type": "…",
"status": "in_progress",
"error": "…",
"started_at": "2026-11-21T15:04:05Z",
"finished_at": "2026-11-21T15:04:05Z"
}
]
}