Webhook Trigger

Triggers the workflow via an incoming HTTP call. The request body, headers, and HTTP method are available in the output.

Parameters

Parameter	Type	Required	Variable	Description
`path`	text	Yes	No	Webhook URL path. The workflow triggers when this path receives a request. Must start with `/`. (format: `^/[a-zA-Z0-9\-_/]*$`)
`method`	choice (`GET`, `POST`, `PUT`, `DELETE`)	Yes	No	HTTP method accepted by the webhook. (Default: `"POST"`)
`authentication`	object	No	No	Authentication configuration to secure the webhook (none, header with API key, or HMAC-SHA256 signature).
`responseMode`	choice (`immediate`, `wait`)	No	No	Response mode: immediate response or wait for workflow completion. (Default: `"immediate"`)
`responseCode`	number	No	No	HTTP status code returned to the caller. (Default: `200`)
`responseBody`	dynamic value	No	Yes	Response body returned to the caller. Can be a literal or a variable.
`outputVariable`	text	No	No	Output variable name containing the incoming request body, headers, and query params.

Parameters marked Variable = Yes accept the {{blockName.field}} syntax.

Output variable : webhookPayload

{
  "body": {},
  "headers": {},
  "method": "..."
}

Receive a webhook notification from an external service.

Input :

{}

Output :

{"body": {"event": "order.created", "data": {"orderId": "ORD-123"}}, "headers": {"content-type": "application/json"}, "method": "POST"}

Tip

Use {{webhookPayload.body}} to access the request body. The webhook path is configured in the block settings.