iTwin Webhooks icon

iTwin Webhooks

iTwin Webhooks API for event subscription and management

Actions4

Overview

This node integrates with the iTwin Webhooks API to manage event subscriptions and webhooks. Specifically, the "Delete webhook" operation allows users to remove an existing webhook by its ID. This is useful in scenarios where you want to stop receiving events from a particular webhook or clean up unused webhook subscriptions.

Practical examples include:

  • Automatically deleting webhooks that are no longer needed after a certain workflow completes.
  • Managing webhook lifecycle by programmatically removing outdated or invalid webhooks.
  • Cleaning up resources during automation or deployment processes.

Properties

Name Meaning
Webhook ID The unique identifier of the webhook to delete.

Output

The output JSON contains the result of the delete operation. Typically, this will be an object indicating success or failure of the deletion request. If the operation returns multiple results (unlikely for delete), each will be output as separate JSON items.

If an error occurs and the node is configured to continue on failure, the output JSON will contain an error field with the error message and additional node information.

No binary data output is expected from this operation.

Dependencies

  • Requires an API authentication token credential for the iTwin platform.
  • The node depends on the iTwin Webhooks API being accessible.
  • No additional environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Webhook ID will cause the operation to fail.
    • Network connectivity problems can prevent successful API calls.
    • Insufficient permissions or expired API tokens may lead to authorization errors.

  • Error messages:

    • "Unknown operation: delete-webhook": Indicates the operation name was not recognized; ensure the correct operation is selected.
    • API errors returned from the iTwin service will be passed through; check the error message for details.
    • If the node fails and "Continue On Fail" is enabled, errors will appear in the output JSON under the error key.

To resolve errors:

  • Verify the Webhook ID is correct.
  • Check API credentials and renew if expired.
  • Ensure network access to the iTwin API endpoint.
  • Review API documentation for permission requirements.

Links and References

Discussion