Webhooks
Introduction
It’s possible to retrieve change-events of breaks 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
POST
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 (breaks). |
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 break record. |
person.id |
integer | Internal ID of the person this break belongs to. |
breakDefinition.id |
integer | Internal ID of the linked break definition. |
date |
string | Date for which the break is recorded (YYYY-MM-DD). |
calculatedDurationInMinutes |
integer | Calculated duration of the break in minutes. |
clockedDurationInMinutes |
integer | Actual clocked duration of the break in minutes. |
startTimeInMinutes |
integer | Earliest start time from the break definition (minutes since midnight). |
endTimeInMinutes |
integer | Latest end time from the break definition (minutes since midnight). |
isBreakTaken |
boolean | Indicates whether the break was taken. |
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
Creating a webhook for breaks
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/breaks",
"collectionName": "breaks"
}