GET [/instances/$INSTANCE]/private/webhooks

This is used to return all the webhooks that are present in our backend.

Required permission: webhooks-read

Response:

200 OK:

The backend has successfully returned all the webhooks. Returns a WebhookSummaryResponse.

401 Unauthorized:

The request is unauthorized.

404 Not found:

The backend has does not know about the instance.

500 Internal Server Error:

The server experienced an internal failure. Returned with TALER_EC_GENERIC_DB_FETCH_FAILED.

Details:

 interface WebhookSummaryResponse {

   // Return webhooks that are present in our backend.
   webhooks: WebhookEntry[];

}

The WebhookEntry object describes a webhook. It has the following structure:

 interface WebhookEntry {

   // Webhook identifier, as found in the webhook.
   webhook_id: string;

   // The event of the webhook: why the webhook is used.
   event_type: WebhookEventType;

}