Webhooks
Subscribes to change events for the validated hours collection.
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
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-webhooks.write and connector-protimeapi-hours-to-validate.read
Body properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
destinationUrl |
string | Yes | Yes | The URL where webhook notifications will be sent. |
collectionName |
string | Yes | Yes | The name of the collection to subscribe to (validated-hours). |
Event properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
changeVersion |
string | — | Read-only | Property to indicate the order of changes. |
id |
integer | — | Read-only | Unique identifier for the validated hours record. |
person.id |
integer | — | Read-only | Internal ID of the person the validated hours belong to. |
date |
string | — | Read-only | Date the validated hours are registered on (YYYY-MM-DD). |
startTimeInMinutes |
integer | — | Read-only | Start time of the validated hours (minutes since midnight). |
endTimeInMinutes |
integer | — | Read-only | End time of the validated hours (minutes since midnight). |
durationInMinutes |
integer | — | Read-only | Duration of the validated hours, in minutes. |
External references
The endpoint supports predefined and custom external references. See the external references page for details.
The following collections are supported for this endpoint:
| Collection | Predefined | Custom |
|---|---|---|
people |
@badge-number, @employee-number |
Supported |
Error responses
| Status | Condition |
|---|---|
400 |
Invalid destination URL or unknown collection name |
401 |
Missing or invalid access token, or insufficient scope |
Success response
201 Created with webhookKey and validUntil in the response body.
Examples
Creating a webhook for validated hours
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/validated-hours",
"collectionName": "validated-hours"
}