Webhook
Call an external HTTP endpoint to sync data or trigger other systems. Add it from Add Condition, Record or Action → Action → Webhook. Every field supports {{template}} tokens.
Request
| Field | Required | Description |
|---|---|---|
| URL | Yes | The endpoint to call (for example, https://api.example.com/webhook/{{trigger.id}}). |
| Method | Yes | GET, POST, PUT, PATCH, or DELETE. |
Authentication (optional)
| Method | Fields |
|---|---|
| None | — |
| Header Auth | Header name and value (for example, x-api-key). |
| Bearer Token | The token, sent as Authorization: Bearer …. |
| Basic Auth | Username and password. |
Request headers (optional)
Add custom headers as Key / Value pairs. Values support {{template}} tokens.
Request body
Shown for POST, PUT, and PATCH. Choose the body mode:
- Raw JSON — Write the JSON body directly.
- Key-Value — Build the body from key/value pairs.
Response
Choose how the response is handled:
- Fire and forget — Send the request without capturing the response. Use it for notifications and logging.
- Wait for response — Wait for the reply and capture it for later steps.
When you wait for a response, configure:
| Field | Description |
|---|---|
| Test webhook | Send a live request with the current configuration. The captured response populates the schema for Select from response mode. |
| Schema source | How to shape the response: No response needed, Select from response (requires a test first), or Define custom schema. |
| Response name | The alias used to reference the response downstream (camelCase, for example webhookResponse). |
| Response required | Turn on to fail the automation if the response is missing. |
Define custom schema
Map each response field to a name you reference later: a Key, a Type (string, number, boolean, object, array), a Map to path (for example, response.data.id), and whether it is required.
Example
Action: Webhook
URL: https://crm.example.com/api/contacts
Method: POST
Authentication: Bearer Token
Body (Raw JSON): { "email": "{{customer.email}}" }
Response: Wait for response
Schema source: Define custom schema → id (string) ← response.data.id
Response name: crmResponse
Related
- Actions overview — All action types
- Mutations — Store webhook response data
- Builder interface guide — The value picker