...
When subscribing to a change type, each time a corresponding internal event occurs, a notification will be sent to the URL registered for the integration endpoint. For instance, both AssetCreated and AssetDeleted events will trigger the same AssetChanged notification on all endpoints that subscribe to AssetChanged events.
Note that, it is possible to provide custom headers for the notification HTTP messages when registering an integration endpoint. This, however, is optional.
When using the API, make sure that your user has the required roles for the requested endpoint. In particular, the roles “Integration_Endpoints_View” and “Integration_Endpoints_CRUD” are required for a lot of the endpoints.
Note that, it is also is possible to get, retry, and purge failed messages with the API.
| Info |
|---|
Detailed More comprehensive Swagger documentation can be found at “/api-docs”. |
...
Notifications are, by definition, push-based. Thus, for an integration endpoint to receive notifications it should listen for incoming HTTP POST messages at the registered URL to receive notifications. A notification generally has the following JSON formatted body:
...
The value of the “ChangeType” parameter is an integer, which is used to identify a its change type. The mapping between ChangeTypes and their integer representations can be retrieved at “/IntegrationService/ChangeTypes”. For each of the change types, an additional data parameter is provided. The specific IDs are:
...