Appearance
Webhooks and the API
This is the integration that means you are never blocked. Anything that speaks HTTP can be reached from a playbook, and anything that can make an HTTP call can start one.
Outbound: call any API from a playbook
| Capability | Detail |
|---|---|
| Method | GET, POST, PUT, PATCH, DELETE |
| URL | Static, or built from a template using values the playbook has produced |
| Body | A template rendered from playbook context, usually JSON |
| Headers | Set inline, or supplied by a stored organisation credential so no secret sits in the playbook |
| Auth | Whatever the target expects. The credential is resolved at run time |
| Retries | Three attempts with exponential backoff on retryable failures |
| Response | Parsed and available to later steps |
| Egress control | Every outbound call passes an egress policy and is audited |
Inbound: let anything trigger a playbook
| Method | Best for |
|---|---|
| Share link | Giving one external tool access to exactly one playbook, with no API key to leak |
| API key | Server-to-server calls from your own backend |
| Scheduled trigger | Time-based runs with no caller at all |
| Event trigger | Running on an internal event, for example an article being approved |
What webhooks and the API can be used for
Webhooks can be used for building an integration that does not exist yet, without waiting for anyone.
Webhooks can be used for connecting internal systems that will never have a public connector, because they are yours alone.
Webhooks can be used for enriching a record in another system with an answer generated from your company brain.
Webhooks can be used for two-way workflows, where an external tool starts a playbook and the playbook calls back with the result.
The API can be used for embedding Studio in your own product, driving content generation or chat from your own interface.
The API can be used for provisioning at scale, creating and configuring sites, playbooks and credentials from code rather than by hand.
Combined with other integrations
| Combination | What it gives you |
|---|---|
| Webhooks + company brain | Any system in your estate gets grounded answers, on demand |
| Webhooks + n8n | Visual glue for the messy parts, code for the rest |
| Webhooks + Google Sheets | A spreadsheet as the front end of a real workflow |
| API + MCP | The same capabilities available to your team's AI assistants |
Frequently asked
Where do I put credentials? In an organisation credential, referenced by id from the step. Secrets never live in playbook configuration.
Can it call an internal host? Outbound calls pass an egress policy. Reaching a private network requires deliberate configuration rather than being available by default.
How do I get an API key? See API keys. Every capability in the interface has an endpoint behind it.