Skip to main content
PATCH
Create or update the webhook endpoint

Authorizations

api-key
string
header
required

Body

application/json

Partial update; only the provided fields change. url and events are required when no webhook endpoint exists yet.

url
string<uri>

https endpoint that will receive deliveries.

description
string
events
enum<string>[]

Event types to subscribe to. When provided, replaces the current list (at least one).

Minimum array length: 1

An event type a webhook endpoint can subscribe to.

Available options:
api.entity.created,
api.entity.updated,
api.account.created,
api.account.updated,
api.account.deleted,
api.payment.created,
api.payment.updated,
api.limitation.updated
isActive
boolean

Response

The webhook endpoint.

url
string<uri>
required

The https endpoint deliveries are POSTed to.

events
enum<string>[]
required

An event type a webhook endpoint can subscribe to.

Available options:
api.entity.created,
api.entity.updated,
api.account.created,
api.account.updated,
api.account.deleted,
api.payment.created,
api.payment.updated,
api.limitation.updated
isActive
boolean
required

When false, deliveries to this endpoint are paused.

description
string
createdAt
string<date-time>
updatedAt
string<date-time>