Webhook
Last updated
Last updated
Use the Webhook node to create webhooks, which can receive data from apps and services when an event occurs. It's a trigger node, which means it can start an n8n workflow. This allows services to connect to n8n and run a workflow.
You can use the Webhook node as a trigger for a workflow when you want to receive data and run a workflow based on the data. The Webhook node also supports returning the data generated at the end of a workflow. This makes it useful for build a workflow to process data and return the results, like an API endpoint.
The webhook allows you to trigger workflows from services that don't have a dedicated app trigger node.
While building or testing a workflow, use a test webhook URL. Using a test webhook ensures that you can view the incoming data in the editor UI, which is useful for debugging. Select LISTEN FOR EVENT to register the webhook before sending the data to the test webhook. The test webhook stays active for 120 seconds.
When your workflow is ready, switch to using the production webhook URL. You can then activate your workflow, and workflow runs it automatically when an external service calls the webhook URL.
When working with a Production webhook, ensure that you have saved and activated the workflow. Data flowing through the webhook isn't visible in the editor UI with the production webhook.
These are the main node configuration fields.
The Webhook node has two URLs: test URL and production URL. n8n displays the URLs at the top of the node panel. Select Test URL or Production URL to toggle which URL workflow displays.
Test: iMBrace registers a test webhook when you select Listen for Event, if the workflow isn't active. When you call the webhook URL, iMBrace displays the data in the workflow.
Production: iMBrace registers a production webhook when you activate the workflow. When using the production URL, workflow doesn't display the data in the workflow. You can still view workflow data for a production execution: Go to the Executions webpage, then select the workflow execution you want to view.
The Webhook node supports standard HTTP Requests.
By default, this field contains a randomly generated webhook URL path, to avoid conflicts with other webhook nodes.
You can manually specify a URL path, including adding route parameters. For example, you may need to do this if you use iMBrace to prototype an API, and want consistent endpoint URLs.
The Path field can take the following formats:
/:variable
/path/:variable
/:variable/path
/:variable1/path/:variable2
/:variable1/:variable2
Immediately: the Webhook node returns the response code and the message Workflow got started.
When Last Node Finishes: the Webhook node returns the response code and the data output from the last node executed in the workflow.
Using 'Respond to Webhook' Node: the Webhook node responds as defined in the Respond to Webhook node.
Customize the HTTP response code that the Webhook node returns upon successful execution.
Choose what data to include in the response body.
Select Add Option to view more configuration options. The available options depend on your node parameters. Refer to the table for option availability.
Binary Data: enabling this setting allows the Webhook node to receive binary data, such as an image or audio file.
Ignore Bots: ignore requests from bots like link previewers and web crawlers.
No Response Body: enable this to prevent iMBrace sending a body with the response.
Raw Body: specify that the Webhook node will receive data in a raw format, such as JSON or XML.
Response Content-Type: choose the format for the webhook body.
Response Data: send custom data with the response.
Response Headers: send additional headers in the Webhook response. Refer to MDN Web Docs | Response header to learn more about response headers.
Property Name: by default, n8n returns all available data. You can choose to return a specific JSON key, so that n8n returns the value.
Binary data
Either: HTTP Method > POST HTTP Method > PATCH HTTP Method > PUT
Ignore Bots
Any
No Response Body
Respond > Immediately
Raw Body
Any
Response Content-Type
Both: Respond > When Last Node Finishes Response Data > First Entry JSON
Response Data
Respond > Immediately
Response Headers
Any
Property Name
Both: Respond > When Last Node Finishes Response Data > First Entry JSON
The HTTP Request node makes HTTP requests to the URL you specify.
Create a new workflow.
Add the HTTP Request node to the workflow.
Select a method from the Request Method dropdown list. For example, if you select GET as the HTTP method in your Webhook node, select GET as the request method in the HTTP Request node.
Copy the URL from the Webhook node, and paste it in the URL field in the HTTP Request node.
If using the test URL for the webhook node: execute the workflow with the Webhook node.
Execute the HTTP Request node.
