diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook.md index 894353e85..728ceae4f 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook.md @@ -52,17 +52,7 @@ The Webhook node has two URLs: test URL and production URL. n8n displays the URL * **Production**: n8n registers a production webhook when you activate the workflow. When using the production URL, n8n doesn't display the data in the workflow. You can still view workflow data for a production execution: select the **Executions** tab in the workflow, then select the workflow execution you want to view. -### Authentication -You can require authentication for any service calling your webhook URL. - -* [**Basic Auth**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication){:target=_blank .external-link}: a method of authentication where calls to the webhook URL must include the username and password in the request header. -* [**Header Auth**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization){:target=_blank .external-link}: a method of authentication where calls to the webhook URL must include the specified header parameter. For example, use this method when you want to authenticate using an API key or an access token. - - /// note | Credential data can vary - The **Credential Data** required for header auth credentials depends on the type used. For example, if you need to provide an `Authorization: Bearer ` header, the Credential Data `Name` will be `Authorization` and the `Value` will be `Bearer `. - /// -* [**JWT Auth**](https://jwt.io/introduction/){:target=_blank .external-link}: a method of authentication that uses JSON Web Tokens (JWT) to digitally sign data. This authentication method uses the [JWT credential](/integrations/builtin/credentials/jwt/) and can use either a **Passphrase** or **PEM Key** key type. ### HTTP Method @@ -79,7 +69,7 @@ The Webhook node supports standard [HTTP Request Methods](https://developer.mozi 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 n8n to prototype an API, and want consistent endpoint URLs. +You can manually specify a URL path, including adding route parameters. For example, you may need to do this if you use n8n to prototype an API and want consistent endpoint URLs. The **Path** field can take the following formats: @@ -89,6 +79,20 @@ The **Path** field can take the following formats: - `/:variable1/path/:variable2` - `/:variable1/:variable2` +### Authentication + +You can require authentication for any service calling your webhook URL. + +* [**Basic Auth**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication){:target=_blank .external-link}: a method of authentication where calls to the webhook URL must include the username and password in the request header. Create or select a basic auth credential for the node to use. Refer to the HTTP Request node [Using basic auth](/integrations/builtin/credentials/httprequest/#using-basic-auth-or-digest-auth) documentation for more information. +* [**Header Auth**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization){:target=_blank .external-link}: a method of authentication where calls to the webhook URL must include the specified header parameter. For example, use this method when you want to authenticate using an API key or an access token. Create or select a header auth credential with a name/value pair for the node to use. Refer to the HTTP Request node [Using header auth](/integrations/builtin/credentials/httprequest/#using-header-auth) documentation for more information. + + /// note | Credential data can vary + The **Credential Data** required for header auth credentials depends on the type used. For example, if you need to provide an `Authorization: Bearer ` header, the Credential Data `Name` will be `Authorization` and the `Value` will be `Bearer `. + /// + +* [**JWT Auth**](https://jwt.io/introduction/){:target=_blank .external-link}: a method of authentication that uses JSON Web Tokens (JWT) to digitally sign data. This authentication method uses the [JWT credential](/integrations/builtin/credentials/jwt/) and can use either a **Passphrase** or **PEM Key** key type. +* **None**: The node won't use authentication. + ### Respond * **Immediately**: The Webhook node returns the response code and the message **Workflow got started**. @@ -97,7 +101,7 @@ The **Path** field can take the following formats: ### Response Code -Customize the [HTTP response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status){:target=_blank .external-link} that the Webhook node returns upon successful execution. +Customize the [HTTP response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status){:target=_blank .external-link} that the Webhook node returns upon successful execution. Select from common response codes or create a custom code. ### Response Data @@ -108,6 +112,7 @@ Choose what data to include in the response body: * **First Entry Binary**: The Webhook returns the binary data of the first entry of the last node in a binary file. * **No Response Body**: The Webhook returns without a body. +Applies only to **Respond > When Last Node Finishes**. ## Node options @@ -116,7 +121,7 @@ Select **Add Option** to view more configuration options. The available options * **Allowed Origins (CORS)**: Set the permitted cross-origin domains. Enter a comma-separated list of URLs allowed for cross-origin non-preflight requests. Use * (default) to allow all origins. * **Binary Property**: Enabling this setting allows the Webhook node to receive binary data, such as an image or audio file. Enter the name of the binary property to write the data of the received file to. * **Ignore Bots**: Ignore requests from bots like link previewers and web crawlers. -* **IP(s) Whitelist**: Enable this to limit who (or what) can invoke a Webhook trigger URL. Enter a comma-separated list of allowed IP addresses. If left blank, all IP addresses are allowed. +* **IP(s) Whitelist**: Enable this to limit who (or what) can invoke a Webhook trigger URL. Enter a comma-separated list of allowed IP addresses. Access from IPs outside the whitelist throws a 403 error. If left blank, all IP addresses can invoke the webhook trigger URL. * **No Response Body**: Enable this to prevent n8n 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. @@ -124,12 +129,10 @@ Select **Add Option** to view more configuration options. The available options * **Response Headers**: Send additional headers in the Webhook response. Refer to [MDN Web Docs | Response header](https://developer.mozilla.org/en-US/docs/Glossary/Response_header){:target=_blank .external-link} 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. - - | Option | Required node configuration | | ------ | --------------------------- | | Allowed Origins (CORS) | Any | -| Binary Property | Either:
HTTP Method > POST
HTTP Method > PATCH
HTTP Method > PUT | +| Binary Property | Either:
HTTP Method > POST
HTTP Method > PATCH
HTTP Method > PUT | | Ignore Bots | Any | | IP(s) Whitelist | Any | | No Response Body | Respond > Immediately | @@ -205,7 +208,7 @@ By default, the response format is JSON or an array. To send a response of type 2. Select **Response Data** > **First Entry JSON**. 3. Select **Add Option** > **Property Name**. 4. Enter the name of the property that contains the response. This defaults to `data`. -5. Connect an Edit Fields node to the Webhook node. +5. Connect an [Edit Fields node](/integrations/builtin/core-nodes/n8n-nodes-base.set/) to the Webhook node. 6. In the Edit Fields node, select **Add Value** > **String**. 7. Enter the name of the property in the **Name** field. The name should match the property name from step 4. 8. Enter the string value in the **Value** field.