Webhook

Receives data from external HTTP requests. Use this trigger to start a workflow whenever an external service sends a request to your webhook URL.

Configuration

Request

Field	Description	Notes
HTTP Method	The HTTP method to accept	GET, POST, PUT, PATCH, DELETE, or HEAD. Defaults to POST.
Path	The URL path segment for this webhook	Required. Supports static segments and route parameters like :orderId. Example: orders/:orderId.

Authentication

Field	Description	Notes
Authentication	How to secure the webhook endpoint	None, Basic Auth, or Header Secret. Defaults to None.
Basic Auth Username	Username for Basic Auth	Shown when Authentication is set to Basic Auth. Required.
Basic Auth Password	Password for Basic Auth	Shown when Authentication is set to Basic Auth. Required.
Secret Header Name	The header name to check for a secret value	Shown when Authentication is set to Header Secret. Defaults to X-Webhook-Secret.
Secret Header Value	The expected value of the secret header	Shown when Authentication is set to Header Secret. Required.

Response (tab)

Field	Description	Notes
Response Mode	When to send a response to the caller	Immediately returns a response right away. Webhook Response Node waits for a Webhook Response node later in the workflow. Defaults to Immediately.
Response Status Code	HTTP status code for the immediate response	Shown when Response Mode is Immediately. Defaults to 200. Range: 100--599.
Response Content Type	Content type of the immediate response	Shown when Response Mode is Immediately. Options: JSON, Plain Text, HTML, XML. Defaults to JSON.
Immediate Response Body	The body to return to the caller	Shown when Response Mode is Immediately. Supports templates from the incoming payload, e.g., {{data.body.id}} or {{data.params.orderId}}. Defaults to {"success": true}.
Response Headers	Custom headers to include in the response	Shown when Response Mode is Immediately. Key-value pairs.

Webhook URL

Once your workflow is published, your webhook is available at:

https://your-domain/api/webhook/{token}/{path}

The {token} is unique to your team and the {path} is the value you configured above.

Output

The Webhook trigger passes through the incoming request data, which typically includes:

• body -- The parsed request body
• headers -- The request headers
• params -- Route parameters (e.g., orderId from :orderId)
• query -- Query string parameters

WARNING

If you need to return dynamic data based on workflow processing results, set Response Mode to Webhook Response Node and add a Webhook Response node downstream.

TIP

Always enable authentication on production webhooks to prevent unauthorized access. Basic Auth or Header Secret are both simple and effective.