Overview
This node listens for events from the iTwin Platform via webhooks and triggers workflows based on those events. It is useful for automating processes that depend on changes or actions within the iTwin ecosystem, such as when an iModel is created, an issue is updated, or a member is added to an iTwin. For example, you could use this node to start a workflow that sends notifications when a new issue is created or to update a database when a form is modified.
Properties
| Name | Meaning |
|---|---|
| Events | The specific iTwin Platform events that should trigger the workflow. Multiple events can be selected. Examples include "iModels - iModel Created", "Issues - Issue Updated", "Forms - Form Created", etc. |
| Webhook Secret | An optional secret string used to verify the webhook signature for security. If left empty, signature verification is skipped. |
| Verify Signature | Whether to verify the webhook signature using HMAC-SHA256. This option is only shown if no webhook secret is provided (i.e., it defaults to true if a secret is set). |
| Additional Options | A collection of extra settings: • iTwin ID Filter: Only trigger for events from a specific iTwin ID; leave empty to receive all events. • Include Raw Headers: Whether to include raw webhook headers in output. |
Output
The node outputs JSON data representing the received webhook event with some enhancements:
- The original event payload is included.
- A
receivedAttimestamp is added indicating when the event was processed. - Optionally, the raw HTTP headers of the webhook request can be included if enabled in the properties.
If the event type does not match the selected events or the iTwin ID filter (if set), the node does not produce any output.
Dependencies
- Requires an active webhook endpoint accessible by the iTwin Platform to receive events.
- If signature verification is enabled, requires the user to provide the correct webhook secret matching the one configured in the iTwin Platform.
- Uses standard cryptographic functions (HMAC-SHA256) for signature verification.
Troubleshooting
- Webhook signature missing but verification is enabled: This error occurs if the webhook request lacks a signature header while signature verification is turned on. Ensure the iTwin Platform sends the signature and the secret is correctly configured.
- Webhook signature verification failed: Indicates the computed HMAC does not match the signature sent by the webhook. Check that the webhook secret matches exactly between the node and the iTwin Platform configuration.
- No output triggered: If the node does not emit data, verify that the incoming event type is among the selected events and that the iTwin ID filter (if set) matches the event's iTwin ID.
- Network or firewall issues may prevent the webhook from reaching n8n; ensure the webhook URL is publicly accessible.
Links and References
- iTwin Platform API Documentation
- Webhook Security Best Practices (general guidance on webhook signature verification)