Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Info

Detailed Swagger documentation can be found at “/api-docs”.

Notifications

Notifications are, by definition, push-based. Thus, an integration endpoint should listen for incoming HTTP POST messages at the registered URL to receive notifications. A notification generally has the following JSON formatted body:

...