Overview
This node implements a UNC (Universal Naming Convention) webhook trigger designed for reuse in workflows. It listens for incoming HTTP POST requests on a specified path and triggers the workflow when such a request is received. The node validates the request using a JWT-based authentication mechanism to ensure secure access.
Common scenarios where this node is beneficial include:
- Integrating external systems that send data via HTTP POST with JWT authentication.
- Creating reusable webhook endpoints secured by JWT tokens.
- Triggering workflows based on authenticated webhook calls, for example, receiving notifications or data updates from third-party services.
Practical example:
- A system sends an authenticated POST request containing JSON data to a specific URL path configured in this node. Upon successful JWT validation, the workflow is triggered, processing the incoming data accordingly.
Properties
Name | Meaning |
---|---|
Path | The URL path at which the webhook listens for incoming POST requests. This must be provided and can be customized per workflow. |
Output
The node outputs the incoming webhook payload as JSON under the json
field. Specifically, it returns an array of JSON objects representing the body data received in the POST request.
If the JWT token validation fails, the node responds with HTTP status 403 (Forbidden) and does not trigger the workflow.
No binary data output is produced by this node.
Dependencies
- Requires a valid API key credential for JWT authentication (referred generically as "an API key credential").
- The node depends on a utility function to validate JWT tokens using the secret key from the credentials.
- The workflow must include a complementary "Respond to Webhook" node to handle sending responses back to the caller; otherwise, the node throws an error indicating the absence of such a node.
Troubleshooting
Error: "No Respond to Webhook node found in the workflow"
This error occurs if the workflow does not contain a node responsible for responding to the webhook request. To fix this, add a "Respond to Webhook" node to your workflow to properly handle responses.HTTP 403 Forbidden Response
If the JWT token is missing, invalid, or expired, the node will reject the request with a 403 status. Ensure that the incoming request includes a valid JWT token in the authorization header and that the API key credential used by the node matches the token's secret.Invalid Path Configuration
Make sure the "Path" property is correctly set and unique within your environment to avoid conflicts with other webhooks.