Skip to main content
Scopes for the v1 API (API Key). Knowledge bases, assistants, and MCP are configured in the dashboard, not part of the v1 reference.
Each scope unlocks a type of operation in Automations. Use only what your integration needs.

​
How to send the key

Recommended
Alternative
The API key belongs to one workspace. You cannot access another workspace with the same key.

​
Common combinations

Only send events

events:read, events:write

Read only

events:read, automations:read

Build flows via API

events:*, automations:*

Full integration

events:read, events:write, automations:read, automations:write
Empty scope list on creation = ADMIN access. Always restrict in production.

​
Events (events:*)

List and fetch event definitions.
Create, update, and delete events. Send event to start runs.

​
Automations (automations:*)

List automations, fetch detail, and list runs.
Create, update, delete automations, and stop a running automation.

​
Sends inside the flow

Steps that send WhatsApp, email, SMS, etc. use the same send engine as channels. The key needs the matching send scopes (whatsapp:send, email:send, sms:send, telegram:send, etc.).

​
Common errors

Details in Error responses and the Automations and events spec in the menu.

​
Next steps