Skip to main content

Webhook

Call an external HTTP endpoint to sync data or trigger other systems. Add it from Add Condition, Record or ActionActionWebhook. Every field supports {{template}} tokens.

Request

FieldRequiredDescription
URLYesThe endpoint to call (for example, https://api.example.com/webhook/{{trigger.id}}).
MethodYesGET, POST, PUT, PATCH, or DELETE.

Authentication (optional)

MethodFields
None
Header AuthHeader name and value (for example, x-api-key).
Bearer TokenThe token, sent as Authorization: Bearer ….
Basic AuthUsername 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:

FieldDescription
Test webhookSend a live request with the current configuration. The captured response populates the schema for Select from response mode.
Schema sourceHow to shape the response: No response needed, Select from response (requires a test first), or Define custom schema.
Response nameThe alias used to reference the response downstream (camelCase, for example webhookResponse).
Response requiredTurn 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