Skip to content

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

FieldDescriptionNotes
HTTP MethodThe HTTP method to acceptGET, POST, PUT, PATCH, DELETE, or HEAD. Defaults to POST.
PathThe URL path segment for this webhookRequired. Supports static segments and route parameters like :orderId. Example: orders/:orderId.

Authentication

FieldDescriptionNotes
AuthenticationHow to secure the webhook endpointNone, Basic Auth, or Header Secret. Defaults to None.
Basic Auth UsernameUsername for Basic AuthShown when Authentication is set to Basic Auth. Required.
Basic Auth PasswordPassword for Basic AuthShown when Authentication is set to Basic Auth. Required.
Secret Header NameThe header name to check for a secret valueShown when Authentication is set to Header Secret. Defaults to X-Webhook-Secret.
Secret Header ValueThe expected value of the secret headerShown when Authentication is set to Header Secret. Required.

Response (tab)

FieldDescriptionNotes
Response ModeWhen to send a response to the callerImmediately returns a response right away. Webhook Response Node waits for a Webhook Response node later in the workflow. Defaults to Immediately.
Response Status CodeHTTP status code for the immediate responseShown when Response Mode is Immediately. Defaults to 200. Range: 100--599.
Response Content TypeContent type of the immediate responseShown when Response Mode is Immediately. Options: JSON, Plain Text, HTML, XML. Defaults to JSON.
Immediate Response BodyThe body to return to the callerShown 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 HeadersCustom headers to include in the responseShown when Response Mode is Immediately. Key-value pairs.

Webhook URLs

Each Webhook trigger node has two URLs with separate tokens:

Test URL

https://your-domain/api/webhook-test/{test_token}/{path}
  • Available the moment you save the node — no publish required.
  • Runs your working version of the workflow, so edits take effect immediately on the next request.
  • Intended for development and debugging. Use this while building the workflow.

Production URL

https://your-domain/api/webhook/{token}/{path}
  • Generated on the first publish of the workflow.
  • Runs your published version. Changes you make to the working version don't affect the production URL until you publish again.
  • Use this for live integrations with external services.

Both URLs are shown in the node's configuration dialog with a copy button. Each token is unique and stable — copying the URL once and re-using it later continues to work after edits and re-publishes.

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.