Contents

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

This is used to update a webhook.

Required permission: webhooks-write

Request:

The request must be a WebhookPatchDetails.

Response:

204 No content:

The webhook has successfully modified.

404 Not found:

The webhook(ID) is unknown to the backend.

409 Conflict:

The provided information is inconsistent with the current state of the webhook. Changes made is the same with another store.

Details:

 interface WebhookPatchDetails {

   // 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;

}