Endpoint: webhooks

This endpoint is used to register and manage webhooks. Thus, an external HTTP(S) server can be stored, which is notified of changes to Conigma Repository objects by means of an HTTP request. Webhooks are registered at object type level, but if required, a filter condition can be defined that can be used to restrict the set of relevant objects.

Provided functionalities

get_all_webhooks

Returns a list of the webhooks registered for an object type

get_webhook

Returns details for a registered webhook

register_webhook

Registration of a new Webhook

update_webhook

Updating a registered webhook

unregister_webhook

Deleting a registered webhook

Content of a HTTP Request triggered by a Webhook

In the current implementation, a webhook always generates an HTTP POST request with the following content:

Content

eventName

Name of the event (CREATE, DELETE or UPDATE)

object

JSON serialized version of the Conigma Repository object. This is essentially the same as the version from the object editor, but also contains the corresponding description.

Example