How to send the key
RecommendedThe API key belongs to one workspace. You cannot access another workspace with the same key.
Common combinations
Only send events
events:read, events:writeRead only
events:read, automations:readBuild flows via API
events:*, automations:*Full integration
events:read, events:write, automations:read, automations:write, assistants:read, assistants:write, assistants:invoke, knowledge_bases:read, knowledge_bases:write, mcp_connections:read, mcp_connections:write, http_tools:read, http_tools:writeEvents (events:*)
events:read
events:read
List and fetch event definitions.
events:write
events:write
Create, update, and delete events. Send event to start runs.
Automations (automations:*)
automations:read
automations:read
List automations, fetch detail, and list runs.
automations:write
automations:write
Create, update, delete automations, and stop a running automation.
Assistants (assistants:*)
assistants:read
assistants:read
List and fetch assistants; list MCP and HTTP tool bindings.
assistants:write
assistants:write
Create, update, and delete assistants; bind/unbind MCP and HTTP tools.
assistants:invoke
assistants:invoke
Invoke assistant in test mode (
POST /v1/assistants/{id}/invoke) and read thread history.Knowledge bases (knowledge_bases:*)
knowledge_bases:read
knowledge_bases:read
List bases and documents; fetch detail including
sourceText.knowledge_bases:write
knowledge_bases:write
CRUD bases and documents (auto re-index after text changes).
MCP (mcp_connections:*)
mcp_connections:read
mcp_connections:read
List and fetch MCP connections.
mcp_connections:write
mcp_connections:write
Create, update, and delete connections;
POST /v1/mcp-connections/{id}/refresh-manifest for CUSTOM_URL.Google/Microsoft OAuth for curated connectors remains dashboard-only; use CUSTOM_URL + bearerToken via API.HTTP tools (http_tools:*)
http_tools:read
http_tools:read
List and fetch REST allowlist tools.
http_tools:write
http_tools:write
Create, update, and delete HTTP tools.
Pipelines (pipelines:*)
pipelines:read
pipelines:read
Boards, overview, cards per contact.
pipelines:write
pipelines:write
CRUD boards, columns, cards, and moves.
Sending pools (sending_pools:*)
sending_pools:read
sending_pools:read
List pools, detail, and stats.
sending_pools:write
sending_pools:write
CRUD pools and members (WhatsApp instances).
AI Web Widget admin (ai_widgets:*)
ai_widgets:read
ai_widgets:read
List widgets and add-on messages.
ai_widgets:write
ai_widgets:write
CRUD widgets, rotate key/HMAC, duplicate.
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.