Automations and webhooks
Found this helpful? Share it:
Found this helpful? Share it:
An automation runs an agent without you in the loop: on a schedule you
set, or the moment an external system calls its webhook. Both are
managed over the /automations family of the API ⏰
Create an automation with a cron schedule and idapt starts the agent run for you at each tick. The run behaves like any agent run: it can use tools, write files, and send notifications.
Create a webhook automation and idapt gives it a bearer token. Any system that can make an HTTP request fires the run by calling the fire endpoint with that token, so a deploy, a form submission, or a cron job elsewhere can kick off an agent.
curl -X POST \
https://idapt.app/api/v1/automations/AUTOMATION_ID/fire \
-H "Authorization: Bearer AUTOMATION_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "payload": { "ref": "main", "status": "passed" } }'The fire token is the automation's own token, not your API key.
Rotate it with rotate-secret if it leaks. Webhook fires
are limited to 60 per hour per automation.
Manage automations, inspect their runs, and test one before you wire it up:
| Endpoint | What it does |
|---|---|
GET /automations | List automations. |
GET /automations/cost-stats | Get automation cost stats keyed by automation id. |
GET /automations/:id | Get an automation by id. |
POST /automations | Create an automation (cron / webhook). |
PATCH /automations/:id | Update an automation. |
DELETE /automations/:id | Delete an automation. |
POST /automations/:id/archive | Archive an automation. |
POST /automations/:id/unarchive | Unarchive an automation. |
POST /automations/:id/fire | Fire a webhook automation using its bearer token. |
POST /automations/:id/test-fire | Test-fire an automation now. |
GET /automations/:id/cost-stats | Get one automation's cost stats. |
GET /automations/:id/runs | List an automation's runs. |
GET /automations/runs | List automation runs in a workspace. |
POST /automations/:id/runs/:runId/cancel | Cancel a queued or cancellable automation run. |
POST /automations/:id/runs/:runId/retry | Admit a new attempt for a retryable terminal run. |
POST /automations/:id/rotate-secret | Rotate a webhook automation's secret. |
Use test-fire to run an automation once from your own
session while you build it, then hand the fire endpoint its token for
the real integration.
An automation run can notify your team when it finishes or when something needs a human. See the Notifications API. To build the agent an automation runs, see Agents.
Related articles
Agents
Create AI personas with custom instructions, their own memory, and their own default model.
Notifications API
Send notifications to workspace members and manage your inbox programmatically.
Rate limits and errors
Every error shape the API returns, what each rate limit is, and how to handle a wall in code.
Was this helpful?