Webhooks
Introduction
It’s possible to retrieve change-events of work interruptions with webhooks.
Caution
Read the Webhooks page. There is important information on required implementation!
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
Body properties
This list of properties is applicable for this endpoint.
| Property | Type | Description |
|---|---|---|
destinationUrl |
string | The URL where webhook notifications will be sent. |
collectionName |
string | The name of the collection to subscribe to (work-interruptions). |
Event properties
This list of properties is posted to your consumer endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Unique identifier for the work interruption record. |
person.id |
integer | Internal ID of the person this work interruption belongs to. |
date |
string | Date for which the work interruption is recorded (YYYY-MM-DD). |
durationInMinutes |
integer | Duration of the work interruption in minutes. |
startTimeInMinutes |
integer | Start time of the work interruption (minutes since midnight). |
endTimeInMinutes |
integer | End time of the work interruption (minutes since midnight). |
External references
It’s possible to use predefined external references and custom external references. More information can be found on the External References Page
For a list of predefined external references, see the external reference options section.
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Examples
Create a webhook subscription with external reference
Example to create a webhook subscription with the employee number as an external reference:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks?externalReferences=(people,@employee-number)
{
"destinationUrl": "https://your-endpoint.com/webhook",
"collectionName": "work-interruptions"
}