Webhook Fields

The following fields for the webhook form are listed, along with recommendations for their use.

Disabled

The “Disabled” checkbox should be set if the webhook cannot send requests to the URI.

Event

The “Event” field allows you to select the type of event that triggers the webhook to send requests to the URI.

URI

The “URI” field specifies the uniform resource identifier (URI) used to identify the resource that the webhook sends a POST request to when the selected event occurs.

Webhook Policy

The “Webhook Policy” field allows you to select webhook policy, which defines how webhook messages are cryptographically signed.

Description

The “Description” field allows you to enter a descriptive explanation of how the webhook is used.

Email Address for Errors

The “Email Address for Errors” field allows you to enter an email address (email) that will receive notifications when errors occur. When an error is detected, a notification about the repeated attempt to access the URI will be sent to this address. The number of attempts for a specific request is limited to 10. The interval between attempts increases with each failed attempt. If a specific request remains unsuccessful after 10 attempts, further attempts for that request will not be made. During a repeated attempt, the same webhook may trigger again. To prevent sending an excessive number of error emails, only 1 email every 20 minutes per webhook will be sent. If this field is left blank, error notifications will be sent to every person with the account administrator role in which the webhook is registered.

Last Delivery

The “Last Delivery” field contains a link to the webhook delivery, created after the last triggering of the webhook.