Create webhook
Creates a webhook: a payload URL that receives the events that it subscribes to, so that your system learns about each change without polling. Get the event types from Read webhook event types, and subscribe to at least 1.
List all webhooks
Lists the webhooks of the organisation (or of the sandbox organisation of the call), the newest first, each with the result of its last delivery. Deleted webhooks are not listed. Use `offset` and `limit` to page through the list; an `offset` below 0 or a `limit` of 0 or less gets the default.
Read webhook
Returns one webhook of the organisation (or of the sandbox organisation of the call), with its subscribed event types and its secret key in clear text. A deleted webhook is not found.
Update webhook
Replaces the settings of a webhook: the payload URL, the content type, the subscribed event types, the disabled flag, the secret key and the TLS check flag. Use it to change the event types, to rotate the secret key, or to pause the webhook with `disabled`.
Delete webhook
Deletes a webhook. The service disables it and marks it as deleted: it receives no more events, a delivery that waits for its next attempt fails, and the other webhook operations no longer find it. Its payload URL is free for a new webhook. You cannot undo the delete.
Ping webhook
Checks that the payload URL of a webhook answers. The service sends one HTTP `POST` with an empty body to the payload URL, waits for the answer and returns its status. Use it after you create a webhook or change its payload URL.
Read webhook event types
Lists every event type that a webhook can subscribe to, sorted by type, with what it means and the version of its body. Put each `type` in the matching group of `subscribedEvents` when you create or update a webhook: the `ows.*` types in `digitalWalletWebhook`, the `consent.*` and `data.*` types in `consentManagementWebhook`, and `datamarketplace.data_disclosure_agreement_record` in `dataMarketplaceWebhook`. The list is the same for every organisation.
List all webhook content types
Lists the content types that a webhook can use for its payload. The only one is `application/json`: the service posts each event as a JSON body, and the signature covers its exact bytes. A create or update request without `contentType` gets `application/json`.