Automations

Check how automations are running, and start the ones that are started by hand.

Check on automations

With automations:read:

CallReturns
GET /v1/automations?project_id=PROJECT_IDAutomations you can see, each with its trigger and a one-sentence summary
GET /v1/automations/AUTOMATION_IDOne automation
GET /v1/automations/AUTOMATION_ID/runsIts recent runs, newest first
GET /v1/automation-runs/RUN_IDOne run, with every step it took and where it stopped or failed

A failed run has an error, and its steps show which one failed. That makes a simple monitor easy: list recent runs every few minutes and alert on new failures.

Start one from your code

Automations whose trigger is Started by hand have startable: true. These can be started with automations:write, for example from a form submission or another system's webhook.

  1. 1

    Start it

    curl -X POST https://developers.playbookops.ai/v1/automations/AUTOMATION_ID/runs \
      -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY" -H "Content-Type: application/json" \
      -H "Idempotency-Key: $(uuidgen)" \
      -d '{"item_id": "ITEM_ID"}'
    

    If the automation has needs_item: true, pass the item_id to run it on. An app's automation takes a record_id instead.

  2. 2

    Follow the run

    The answer is the new run. Check on it with GET /v1/automation-runs/RUN_ID until it has a finished_at, then look at its status, its error if it failed, and its steps.

Only published automations that are on

The automation must be published and switched on. Automations with any other trigger start on their own, and starting them returns 400.

Reference

ActionEndpointMCP tool
List automationsGET /v1/automationslist_automations
One automationGET /v1/automations/{id}get_automation
Its runsGET /v1/automations/{id}/runslist_automation_runs
One runGET /v1/automation-runs/{id}get_automation_run
Start onePOST /v1/automations/{id}/runsstart_automation

Every parameter is in the API reference.