Skip to main content
An automation contains instructions and can have a trigger. Create and manage it in Flow or through the Customer API, send an event, and use the API to track the resulting runs.

​
Choose a trigger

An automation can have more than one trigger. It runs when any of its triggers fires. Integrations connect external apps to Flow. Automations define the work Flow runs when an event arrives.

​
Set up and run

  1. List or create the project’s automations with GET or POST /project/{projectId}/automations.
  2. Set up a webhook automation: configure its instructions and name, then send a JSON event.
  3. Trigger and poll automations: start runs asynchronously, store their IDs, and read the results.
  4. Use the endpoint reference for complete request and response schemas.
A trigger request matches automations by source. One request can start multiple runs. Include project_id to target the intended project, and track each returned agent_id separately.

​
Manage project automations

Use GET /project/{projectId}/automations to list automations, or add an automation ID to read, update, or delete one. POST /project/{projectId}/automations creates an automation; PATCH /project/{projectId}/automations/{automationId} changes only the fields you send. triggers lists every trigger in order, up to 20, and a supplied list replaces the whole list. Send triggers: [] to make the automation manual. The single trigger field reads as the first trigger. Without triggers, a supplied trigger replaces only the first trigger and keeps the others; null removes the trigger only from an automation that has at most one. If you send both fields, trigger must equal the first entry in triggers. Each trigger has an id. Omit it for a new trigger; a trigger sent without one keeps the ID of the trigger at the same position. Set enabled: false to turn an automation off in either mode. A disabled automation starts no run from a trigger, a schedule, or a manual launch. An automation runs with the permissions of the person who last saved what it runs. When changing another person’s automation in a way that affects its work or trigger, send runAsMe: true to confirm that it will run as you; otherwise the update returns 409. Renaming, disabling, or turning off admin tools keeps the current writer. An API key cannot enable allowAdminTools. Script mode requires the automation scripts beta. Responses for a single automation include a url that links to it in Flow. Through Flow MCP, automations are created turned off and enabled only in Flow; see Create and edit automations.

​
Automation endpoints

All automation endpoints remain in Endpoints. These guides explain how to use them together.