What it does
Each module publishes its events to automations — a deal won, a lead qualified, a leave request approved, an invoice paid, a contract signed. An automation that starts on one of those events can send an HTTP request to your service, with the event's fields in the body. Your service does whatever it needs: update a data warehouse, post to a chat tool's incoming-webhook URL, start its own process.
Setup steps
1. Open Automations and create a workflow.
2. Pick the trigger — the event you want, for example crm.deal.won or sales.invoice.paid.
3. Add an HTTP request step:
- Method and URL — POST https://your-service.com/hooks/deals.
- Headers — put a shared secret here, and have your endpoint check it before doing anything.
- Body — built from the event's fields with {{ … }} templates.
- Timeout — up to 60 seconds.
4. Choose what happens on failure — retry the step up to five times, or let the workflow continue.
5. Publish. From then on, every matching event runs it.
What your endpoint receives
Exactly the body you template. For a deal-won workflow, for example:
{
"event": "crm.deal.won",
"dealId": "{{ id }}"
}
What to know today
- Requests go to public addresses only. Private and internal network addresses are refused, so a workflow cannot be pointed at your own infrastructure's internals by mistake.
- There is no request signature yet. Use a secret header and check it on your side.
- Every run is recorded. The run inspector shows each run of the workflow, step by step, including the HTTP request and whether it succeeded.
- Design for repeats. A retried step can deliver the same event more than once, so make your endpoint safe to call twice with the same data.
Why this exists
The API is how you call the product. Many integrations are better built the other way round — by reacting to what happened in it. An automation with an HTTP request step is that reactive surface, and it runs under the same permissions and records as everything else.
Related
See the MCP server and the API for the call side, and Automation for everything a workflow can do.
