Skip to main content
POST
Use this when you want to patch one or more fields of an existing webhook endpoint (url, description, enabled, subscribedEvents).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Pattern: ^mk_we_[0-9a-f]{16}$

Body

application/json
url
string
Maximum string length: 2048
description
string | null
Maximum string length: 256
enabled
boolean
subscribedEvents
enum<string>[]
Required array length: 1 - 5 elements
Available options:
user.verified,
user.cancelled,
order.created,
order.status_updated,
order.paid

Response

Success

endpointId
string
required
scope
enum<string>
required
Available options:
developer,
merchant
url
string
required
description
string | null
required
enabled
boolean
required
subscribedEvents
enum<string>[]
required
Available options:
user.verified,
user.cancelled,
order.created,
order.status_updated,
order.paid
signingSecretVersion
integer
required
createdAt
string
required
updatedAt
string
required
lastDeliveryAt
string | null
required
lastDeliveryStatus
enum<string> | null
required
Available options:
success,
failure
consecutiveFailures
integer
required
Required range: x >= 0