Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
webhooks

Update webhook

Updates a webhook to replace webhook fields with new values. Supports only the replace operation. Pass a json_patch object with replace operation and path, which is /url for a URL or /event_types for events. The value is either the URL or a list of events.

patch/v1/notifications/webhooks/{webhook_id}

Path parameters

webhook_idstring required

The ID of the webhook for which to list subscriptions.

Request body

op'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required

The operation.

pathstring

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location at which to complete the operation.

{"stackTrail":"components:schemas:patch:properties:value","oasType":"schema","type":"unknown","title":"Patch Value","description":"The value to apply. The <code>remove</code> operation does not require a value."}
fromstring

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location from which to move the value. Required for the <code>move</code> operation.

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows webhook details.

idstring

The ID of the webhook.

urlstring uri required

The URL that is configured to listen on localhost for incoming POST notification messages that contain event information.