Webhooks
Subscribes to change events for the employers 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-employers.read
Body properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
destinationUrl |
string | Yes | Yes | The URL where webhook events will be sent. |
collectionName |
string | Yes | Yes | The name of the collection to subscribe to (employers). |
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 employer. |
name.default |
string | — | Read-only | Default name of the employer. |
name.translations |
object | — | Read-only | Translated names for supported languages. |
externalCode |
string | — | Read-only | External code for the employer. |
address |
string | — | Read-only | Street address of the employer. |
town |
string | — | Read-only | Town or city of the employer. |
postalCode |
string | — | Read-only | Postal code of the employer. |
bankAccount |
string | — | Read-only | Bank account number of the employer. |
companyRegistrationNumber |
string | — | Read-only | Company registration number. |
External references
This endpoint does not support external references for employers.
Error responses
| Status | Condition |
|---|---|
400 |
Invalid destination URL, unknown collection name, or an externalReferences query parameter |
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 employers
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/employers",
"collectionName": "employers"
}