Webhook event handler configuration fields

Version:

This topic describes the webhook event handler fields and supported events.

Webhook event handler fields

You can configure a webhook event handler by configuring the fields in the Data and Information sections of the webhook.

A webhook event handler contains the following configurable fields:

Field	Description
`Enabled`	Determines whether the webhook is enabled. If you select the check box, the webhook is active and sends requests. If you clear the check box, the webhook is disabled and does not send requests.
`Events`	Defines the events that send requests. You can find the list of supported events in the Supported events table. If you do not select any events, the webhook does not send requests.
`Rule`	Specifies which items will trigger requests. If you do not add rules, an event from any item will send a request. We highly recommend that you define rules to avoid performance degradation caused by sending a large number of requests.
`Url`	The endpoint that receives the requests. We recommend that you use a secure HTTPS URL.
`Serialization Type`	Defines the payload request type. The available formats are JSON and XML. JSON is selected by default. For XML requests, the default root element is `event`.
`Authorization`	Defines the authorization item for the webhook. The drop-down menu contains all available authorization items. If the endpoint does not require authentication, leave this field blank.
`Description`	Optional text field to describe the webhook.

A webhook event handler can send information about the following system events:

Event name	Description
`item:added`	Raised when a new item from a template is added.
`item:versionAdded`	Raised when a new version is added to the item.
`item:cloneAdded`	Raised when a new cloned item is added.
`item:deleted`	Raised when the item is deleted.
`item:deleting`	Raised before deleting the item.
`item:versionRemoved`	Raised when a version of the item is removed.
`item:locked`	Raised when the item is locked.
`item:unlocked`	Raised when the item is unlocked.
`item:saved`	Raised when at least one change is saved in the item. This event can occur multiple times during simple item operations on the UI.
`item:copied`	Raised when the item is copied.
`item:moved`	Raised when the item is moved to another parent.
`item:renamed`	Raised when the item is renamed.
`item:sortorderchanged`	Raised when the sort order of the item changes.
`item:templateChanged`	Raised when the item’s template changes.
`publish:begin`	Raised when the publishing of the item starts.
`publish:end`	Raised when the publishing of the item ends.
`publish:fail`	Raised when the publishing of the item fails.
`publish:statusUpdated`	Raised when the status of item publishing updates.

If you have suggestions for improving this article, let us know!