Skip to main content
Update a webhook endpoint

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
url
string<uri>

An absolute HTTPS URL.

Maximum string length: 2048
Pattern: ^https://
status
enum<string>

active can receive events, and inactive receives none, except a delivery Quidkey staff resend.

Available options:
active,
inactive
is_signed
boolean

Whether deliveries are signed. On a merchant's endpoint only.

is_default
boolean

On a merchant's endpoint only. true needs an active endpoint, and clears any other default the merchant has. false clears it.

Response

The webhook_endpoint, in the full view.

result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required