Update an existing webhook subscription

patch

https://sandbox.gateway.orbipayments.com/v1/webhooks/{id}

Allows modification of event subscriptions and activation status. The webhook URL cannot be changed - delete and recreate the webhook if a different URL is needed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique webhook identifier with ULID format and 'whk_' prefix.

This is the internal identifier used to reference webhook resources
across the system. Generated automatically when creating webhooks.

Body Params

events

array of strings

required

Updated list of events that will trigger webhook notifications.

Replaces the existing event subscription list with the provided events.
If not provided, the current event subscriptions remain unchanged.
Each event must be a valid webhook event type and duplicates are not allowed.

events*

Allowed:

is_enabled

boolean

required

New activation status for the webhook subscription.

Controls whether the webhook will actively receive notifications.
When set to true, the webhook will receive events for subscribed types.
When set to false, notifications are suspended but configuration is preserved.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200