Webhooks
Introduction
It’s possible to retrieve change-events of activity durations 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 (activity-durations). |
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 activity duration. |
person.id |
integer | Unique identifier of the person linked to this duration. |
date |
string | Date of the activity duration (YYYY-MM-DD). |
durationInMinutes |
integer | Duration in minutes for the activity. |
activityLevels.level |
integer | A list of levels in the activity structure of the registered activity definition. |
activityLevels.activityDefinition.id |
string | Unique identifier for the activity definition registered. |
absenceDefinition.id |
integer | Unique identifier for the absence definition, if an absence is linked to the duration. |
request.id |
string | Unique identifier for the request, if the duration was requested. |
counterDefinitions.id |
integer | A list of unique identifiers for the counter definitions or multiple definitions, if one or more counters are linked to this duration. |
shiftDefinition.id |
integer | Unique identifier for the shift definition, if a shift is linked to the duration. |
status |
string | Status of the activity duration (Unknown, Auto, Manual). |
isAuthorized |
boolean | Indicates if the activity duration is authorized. |
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
Tip
The shiftDefinition property is typically linked to the activity duration, unless the shift is inherited from the schedule.
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.
Example
A webhook for activity durations
Example for creating a webhook for activity durations:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/activity-durations",
"collectionName": "activity-durations"
}