Actions4
- Resource Actions
Overview
This node integrates with the iTwin Webhooks API, allowing users to manage event subscriptions and retrieve webhook information. The "Get webhook" operation specifically fetches details about a particular webhook by its ID. This is useful in scenarios where you need to inspect or verify webhook configurations, monitor their status, or debug webhook-related issues within the iTwin platform.
Practical examples include:
- Retrieving the configuration of a specific webhook to confirm its subscribed events.
- Checking the status or metadata of a webhook before performing updates or deletions.
- Auditing webhook usage in an automated workflow.
Properties
| Name | Meaning |
|---|---|
| Webhook ID | The unique identifier of the webhook to retrieve. |
Output
The output is a JSON object representing the webhook's details as returned by the iTwin Webhooks API. This typically includes properties such as the webhook's ID, subscribed events, target URL, status, and other metadata related to the webhook configuration.
If multiple webhooks were returned (not applicable here since this operation targets a single webhook), they would be output as an array of JSON objects. No binary data output is involved.
Dependencies
- Requires an API authentication token credential for the iTwin OAuth2 API.
- Depends on the iTwin Webhooks API service being accessible.
- The node uses an internal interpreter module (
WebhooksOpenApiInterpreter) to map operations and execute API calls.
Troubleshooting
Common Issues:
- Providing an invalid or non-existent Webhook ID will likely result in an error from the API indicating that the webhook was not found.
- Missing or incorrect API credentials will cause authentication failures.
- Network connectivity issues can prevent successful API calls.
Error Messages:
"Unknown operation: <operation>"— indicates that the specified operation name is not recognized by the node; ensure the operation parameter is correctly set to "get-webhook".- API errors returned from the iTwin service will be propagated; check the error message for details such as invalid webhook ID or permission issues.
Resolution Tips:
- Verify the Webhook ID is correct and exists in your iTwin environment.
- Ensure valid and active API credentials are configured in n8n.
- Check network access and firewall settings if API calls fail.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Webhooks API documentation for detailed webhook schema and supported operations.