📄️ Create webhook
This endpoint creates a webhook. The webhook sends the events that you subscribe to, to an external IT system. The payload URL must start with `http://` or `https://`, and it must be unique for the organisation. Subscribe to a minimum of 1 event type.
📄️ Read webhook
This endpoint reads 1 webhook of the organisation by its ID.
📄️ Update webhook
This endpoint updates a webhook. The request body replaces the payload URL, the content type, the subscribed events, the disabled flag, the secret key and the SSL verification flag of the webhook. The payload URL must start with `http://` or `https://`, and no other webhook of the organisation can use it. Subscribe to a minimum of 1 event type.
📄️ Delete webhook
This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends no more events, and the other webhook endpoints do not find it. The response contains the webhook in its final state.
📄️ List all webhooks
This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the `offset` and `limit` query parameters to page through the list.
📄️ Ping webhook
This endpoint pings a webhook that was defined to trigger events to an external IT system. Use it to check that the payload URL answers.
📄️ List all webhook deliveries
This endpoint is used to read recent webhook deliveries with pagination from the consent building block that were sent to an external IT system.
📄️ Read webhook delivery
This endpoint reads 1 payload delivery of a webhook. Give the webhook ID and the delivery ID in the path.
📄️ Read webhook event types
This endpoint lists all the webhook event types that you can subscribe to. Use these values in the `subscribedEvents` field when you create or update a webhook. The list is the same for all organisations.
📄️ List all webhook content types
This endpoint lists the payload content types that a webhook can use. Use one of these values in the `contentType` field when you create or update a webhook. The server posts the payload as a JSON body for `application/json`. For `application/x-www-form-urlencoded`, the server makes a string of the payload and posts it as a form under the `payload` key. Note the capital `C` in the `ContentTypes` response field. The order of the values changes between calls.