Webhooks
Introduction
It’s possible to retrieve change-events of people 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
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 (people). |
Event properties
This list of properties is posted to your consumer endpoint.
| Property | Type | Description |
|---|---|---|
id |
integer | Internal unique identifier for the person. |
changeVersion |
string | Property to indicate the order of changes. |
periodClosingDate |
string | Date of the period closing, used to lock the calendar. |
hourlyRateCurrencyDefinition.id |
integer | Internal unique identifier for the hourly rate currency. |
advanceCurrencyDefinition.id |
integer | Internal unique identifier for the advance currency. |
lastName |
string | Last name of the person. |
firstName |
string | First name of the person. |
initials |
string | Initials of the person. |
telephone |
string | Telephone number. |
mobile |
string | Mobile phone number. |
email |
string | Email address. |
address |
string | Street address with the number. |
postalCode |
string | Postal code. |
town |
string | Town or city. |
countryIsoCode |
string | ISO code of the country. |
nationalityIsoCode |
string | ISO code of the nationality. |
sex |
string | Sex of the person (Unknown, Female, Male, Other). |
maritalStatus |
string | Marital status (Unknown, Single, Married, Widow, Widower, Divorced, LivingTogether). |
birthDate |
string | Birth date of the person (YYYY-MM-DD). |
placeOfBirth |
string | Place of birth. |
drivingLicense |
string | Driving license number. |
registerNumber |
string | Register number. |
passportNumber |
string | Passport number. |
socialSecurityNumber |
string | Social security number. |
bankAccount |
string | Bank account number. |
inServiceDate |
string | Date when the person entered service (YYYY-MM-DD). |
outOfServiceDate |
string | Date when the person stopped service (YYYY-MM-DD). To infinity if empty. |
wtdStartDate |
string | WTD start date (YYYY-MM-DD). |
employeeNumber |
string | Employee number. |
payGroup |
string | Pay group of the person. |
hourlyRate |
number | Hourly rate. |
maxAdvance |
number | Maximum advance allowed. |
terminalGroup.id |
integer | Internal unique identifier for the terminal group the person is linked to. |
badgeNumber |
string | Badge number of the person. Needs to be unique. |
pinCode |
integer | PIN code. |
terminalLanguageISOCode |
string | ISO code of the terminal language for this person. |
External references
This endpoint does not require any external references.
Examples
A webhook for people
Example for creating a webhook for people:
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/people",
"collectionName": "people"
}