Webhooks
Introduction
It’s possible to retrieve change-events of absences 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 (absences). |
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 absence instance. |
person.id |
integer | Internal ID of the person for whom the absence is registered. |
resultingAbsenceDefinition.id |
integer | Internal ID of the resulting absence definition. |
requestedAbsenceDefinition.id |
integer | Internal ID of the originally requested absence definition. |
shiftDefinition.id |
integer | Internal ID of the shift definition for the absence. |
date |
string | Date of the absence (YYYY-MM-DD). |
startTimeInMinutes |
integer | Start time of the absence in minutes since midnight. |
durationInMinutes |
integer | Duration of the absence in minutes. |
calculatedDurationInMinutes |
integer | Calculated duration of the absence in minutes. |
dayPart |
string | Part of the day the absence applies to (First, Second, Unknown). |
request.id |
string | ID of the related absence request, formatted as {TenantId}-{PersonId}-{RequestId}. |
status |
string | How the absence was registered (Manual, Auto, BeginOpen, Open, Terminal, Calendar). |
approvalLevel |
string | Approval status (Approved, NotApproved, NotApprovedByPriorities, NotApprovedByCalculations, AwaitingApproval). |
isLocked |
boolean | Indicates if the absence is locked and cannot be changed. |
periodType |
string | Type of period the absence applies to (Unknown, Day, Week, PayPeriod). |
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 behaviour
The shiftDefinition property is typically linked to the absence, 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 absences
Example for creating a webhook for absences:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/absences",
"collectionName": "absences"
}