Datahub Webhooks
Datahub Webhooks adds webhook functionality to Pimcore Datahub. When something happens to an Asset, Document, Data Object or workflow, Pimcore sends an HTTP request to the endpoints you subscribe to. The payload is configurable, so you control exactly which information leaves the system.
Use it to connect Pimcore to other systems based on events.
Features
- React to added, updated and deleted events for Data Objects, Assets and Documents, and to entered and completed events for workflows.
- Configure the payload per configuration:
- Restrict the element (sub) types, and optionally include unpublished elements.
- Select the data object fields to send.
- Embed binary data for assets, including images, videos and thumbnails.
- Restrict a configuration to parts of the element trees with workspaces.
- Send custom headers to your subscribers, and check that they are reachable.
- Log every request, subscriber and HTTP status code per configuration.
Documentation
Start here:
- Installation: install the bundle and run the message queue worker.
- Getting Started: build a first webhook end to end.
Reference:
- Configuration: every tab of a webhook configuration.
- Request Structure: what a subscriber receives.
- Extending: custom processors and Studio API events.
- Upgrade notes: breaking changes per release.