Our Enterprise-package customers are able to use Webhooks with shyftplan.
💡Please contact us to set up webhooks for your shyftplan account.
With Webhooks, standardized messages are sent out to a receiving server of your choice whenever a configured event happens.
Using webhooks you can
- create and maintain your own log history of events in shyftplan
- enable delta-synchronization in your Middleware.
When synchronizing, for example, absences between shyftplan and an external system, Webhooks can tell you that an absence in shyftplan has just been deleted. Then you only have to handle this one difference, the delta, between the two systems.
Without webhooks you can find out about deleted absences solely by
GETting the complete list of currently existing absences and comparing this with a list of previously known absences that your Middleware needs to maintain somewhere.
Currently these events can be set to trigger a notification:
|Destroy (restorable for some objects, e.g. employments)|
|Really destroy (non-restorable)|
These are the objects for which those events can trigger a notification:
As an example, this is the notification your server will receive for a Destroy event on an Absence (if it is set):
The notifications are in JSON format. No guarantee can be given for the order of the entries, and new entries may appear.
Direction of transfer
shyftplan to external system
Relevant endpoints for this use case