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 (shift-definitions). |
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 | Internal unique identifier for the shift definition. |
name.default |
string | Default name value of the shift definition. |
name.translations |
object | A list of translated names of the definition by language code. |
code |
string | A shift code used for this definition. |
friendlyName.default |
string | Default friendly name value for this definition shown to users. |
friendlyName.translations |
object | A list of translated friendly names by language code. |
isEnabled |
boolean | Indicates if the shift definition is enabled in myProtime. |
External references
This endpoint does not require any external references.
Examples
Creating a webhook for shift definitions
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
Request:
{
"destinationUrl": "https://www.fictional-customer.com/protime/shift-definitions",
"collectionName": "shift-definitions"
}