Respond to Webhook
Use the Respond to Webhook node to control the response to incoming webhooks. This node works with the Webhook node.
How to use Respond to Webhook
To use the Respond to Webhook node:
- Add a Webhook node as the trigger node for the workflow.
- In the Webhook node, set Respond to Using 'Respond to Webhook' node .
- Add the Respond to Webhook node anywhere in your workflow. If you want it to return data from other nodes, place it after those nodes.
Node parameters
Configure the node behavior using these parameters.
Respond With
Choose what data to send in the webhook response.
- All Incoming Items : respond with all the JSON items from the input.
- Binary : respond with a binary file defined in Response Data Source .
- First Incoming Item : respond with the first incoming item's JSON.
- JSON : respond with a JSON object defined in Response Body .
- No Data : no response payload.
- Redirect : redirect to a URL set in Redirect URL .
- Text : respond with text set in Response Body .
Node options
Select Add Option to view and set the options.
- Response Code : set the response code to use.
- Response Headers : define response headers to send.
- Put Response in Field : available when you respond with All Incoming Items or First Incoming Item . Set the field name for the field containing the response data.
Return more than one data item
The Respond to Webhook node runs once, using the first incoming data item. This includes when using expressions. You can't force looping using the Loop node: the workflow will run, but the webhook response will still only contain the results of the first execution.
If you need to return more than one data item, you can either:
- Instead of using the Respond to Webhook node, use the When Last Node Finishes option in Respond in the Webhook node. Use this when you want to return the final data that the workflow outputs.
- Use the Aggregate node to turn multiple items into a single item before passing the data to the Respond to Webhook node. Set Aggregate to All Item Data (Into a Single List) .
Workflow behavior
When using the Respond to Webhook node, workflows behave as follows:
- The workflow finishes without executing the Respond to Webhook node: it returns a standard message with a 200 status.
- The workflow errors before the first Respond to Webhook node executes: the workflow returns an error message with a 500 status.
- A second Respond to Webhook node executes after the first one: the workflow ignores it.
- A Respond to Webhook node executes but there was no webhook: the workflow ignores the Respond to Webhook node.