Webhooks
Introduction
It’s possible to retrieve change-events 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
Request properties
This list of properties can be sent in the request body.
| Property | Type | Description |
|---|---|---|
destinationUrl |
string | The URL where webhook events will be sent. |
collectionName |
string | The name of the collection to subscribe to (contracts). |
Event properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Unique identifier for the contract record. |
person.id |
integer | Internal ID of the person. |
code |
string | The Contract code. |
from |
string | Start date of the contract for when it’s active. |
until |
string | End date of the contract. |
contractHoursInMinutes |
integer | Contracted hours in minutes. |
fullTimeEquivalentInMinutes |
integer | The equivalent in minutes for a full-time contract. |
contractPercentage |
number | Percentage of full-time contract. |
numberOfWorkingDaysPerWeek |
number | The number of working days per week. |
numberOfDaysInContractPeriod |
integer | The number of days in the contract period. |
kind |
string | The kind of contract (Contract,Addendum). |
parentContract.id |
integer | Identifier of the parent contract. |
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 contracts
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
Request:
{
"destinationUrl": "https://www.fictional-customer.com/protime/contracts",
"collectionName": "contracts"
}