Contents

GET [/instances/$INSTANCES]/private/webhooks/$WEBHOOK_ID#

This is used to obtain detailed information about a specific webhook.

Required permission: webhooks-read

Response:

200 OK:

The backend has successfully returned the detailed information about a specific webhook. Returns a WebhookDetails.

404 Not found:

The webhook(ID) is unknown to the backend.

Details:

 interface WebhookDetails {

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

   // URL of the webhook where the customer will be redirected.
   url: string;

   // Method used by the webhook
   http_method: string;

   // Header template of the webhook
   header_template?: string;

   // Body template by the webhook
   body_template?: string;

}