Webhooks
Introduction
It’s possible to retrieve change-events of counters 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 (counters). |
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 counter instance. |
shiftDefinition.id |
integer | Unique identifier for the shift definition, if a shift is linked to this counter. |
numberOfInstances |
integer | Number of counter instances. |
request.id |
string | Internal unique identifier for the related request, if the counter was requested. |
status |
string | Status of the counter instance (Unknown, Auto, Manual, Calendar). |
isAuthorized |
boolean | Indicates if the counter instance is authorized. |
person.id |
integer | Unique identifier for the person linked to this counter. |
periodType |
string | Type of period the counter applies to (Unknown, Day, Week, PayPeriod). |
counterDefinition.id |
integer | Unique identifier for the counter definition linked to this counter. |
date |
string | Date of the counter instance that it is registered on. |
startTimeInMinutes |
integer | Start time in minutes from midnight. |
endTimeInMinutes |
integer | End time in minutes from midnight. |
durationInMinutes |
integer | Duration of the counter instance in minutes. |
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.
Good to know
Shift definition behavior
The shiftDefinition property is typically linked to the counter, unless the shift is inherited from the schedule.
Tip
In cases where the shift comes from the schedule, the shiftDefinition is not included in the response. If the shift isn’t inherited from the schedule, the shiftDefinition will be included in the response.
Examples
A webhook for counters
Example for creating a webhook for counters:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/counters",
"collectionName": "counters"
}