Events & Schema Tab

The Events & Schema tab defines two things: which events trigger the webhook, and what the payload sent to each subscriber contains.

Events

Select one or more events. Each time one of them is triggered, a request is sent to all subscribers of this configuration.

warning

Configure the schema definition matching the selected events, as described below. Without it, no request is sent.

The HTTP method of the request depends on the event:

Element type	Event	Method
Data Objects	pimcore.dataobject.postAdd	POST
Data Objects	pimcore.dataobject.postUpdate	PUT
Data Objects	pimcore.dataobject.postUpdateFailure	PUT
Data Objects	pimcore.dataobject.postDelete	DELETE
Data Objects	pimcore.dataobject.postDeleteFailure	DELETE
Assets	pimcore.asset.postAdd	POST
Assets	pimcore.asset.postUpdate	PUT
Assets	pimcore.asset.postUpdateFailure	PUT
Assets	pimcore.asset.postDelete	DELETE
Assets	pimcore.asset.postDeleteFailure	DELETE
Documents	pimcore.document.postAdd	POST
Documents	pimcore.document.postUpdate	PUT
Documents	pimcore.document.postUpdateFailure	PUT
Documents	pimcore.document.postDelete	DELETE
Documents	pimcore.document.postDeleteFailure	DELETE
Workflows	workflow.entered	PUT
Workflows	workflow.completed	PUT

The *Failure events fire when the corresponding operation failed.

Schema Definition Documents

• Document Types: restrict event dispatching to the selected document types.
• Include unpublished: also react to unpublished documents. It additionally lets version-only saves (saving a draft without publishing) trigger the webhook, because the published check is skipped entirely once the option is on. There is no separate control for that, so expect more requests with this enabled. With it disabled, only published documents that are not version-only saves trigger a request.

note

Auto-saves never trigger a webhook. The event listeners drop any element event carrying the isAutoSave argument before it reaches the queue, independently of this option.

info

The selectable document types default to Page, Snippet, Email, Folder, Hardlink, Link, Newsletter, PrintContainer and PrintPage. To offer other types, for example Headless Documents, override the list in the configuration. The override replaces the default list, so repeat every type you want to keep. See Installation.

Schema Definition Assets

• Asset Types: restrict asset-based events to the selected asset types.
• Asset Data Settings: what binary data to embed in the payload.
  • Include Image data: choose Include no data, Include original data, or one of the configured image thumbnails.
  • Include Video data: choose Include no data, Include original data, or one of the configured video thumbnails.
  • Include other document data: include the binary data of other asset types, for example PDF, CSV or XLSX.

info

The selectable asset types default to Image, Audio, Archive, Folder, Document, Text, Unknown and Video. Overriding the list follows the same rules as for documents.

caution

By default no binary data is sent. To send an image, a video or another asset's contents, select it explicitly in Asset Data Settings. The data is base64-encoded into the data64 field of the payload's subject section, which grows the request considerably.

Schema Definition Data Objects

Add data object classes and select which of their fields are sent to the subscribers.

• Settings: select the fields to include with the gear icon in the Settings column.

Selected fields for a webhook listening to data object events

• Include unpublished: also react to unpublished data objects. As for documents, it additionally lets version-only saves trigger the webhook, because the published check is skipped entirely once the option is on. With it disabled, only published data objects that are not version-only saves trigger a request.

Assets have no equivalent option. Asset events are matched by type and workspace only.

Schema Definition Workflows

• Workflows: the workflows whose workflow.entered and workflow.completed events dispatch a request.

Workflow events are matched by workflow name only. Neither the workspace configuration nor the published state of the element is evaluated for them, so every transition of a selected workflow dispatches a request regardless of where the element lives in the tree.

warning

Matching is not the whole story for data objects. The workflow payload is built by the same extractor as the element events, so the object's class still needs an entry under Schema Definition Data Objects above. Without it the payload cannot be built and no request reaches the subscribers, even though the workflow name matched.