Webhooks
Introduction
It’s possible to retrieve change-events of counter definitions 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 (counter-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 counter definition. |
name.default |
string | Default name value of the counter definition. |
name.translations |
object | A list of translated names of the definition by language code. |
code |
string | A counter 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. |
friendlyCode.default |
string | Default friendly code value for this definition shown to users. |
friendlyCode.translations |
object | A list of translated friendly codes by language code. |
isEnabled |
boolean | Indicates if the counter definition is enabled in myProtime. |
counterGroup.id |
integer | The ID of the associated counter group. |
unit |
string | The unit type for the counter definition (Unknown, Interval, Duration, Instance). |
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 counter definitions
POST
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/counter-definitions",
"collectionName": "counter-definitions"
}