Skip to main content
PATCH
Update webhook

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Body

application/json

eventType and secret are not accepted on create/update: the server defaults eventType to GENERAL and generates the secret (both returned on the Webhook response).

name
string
required
url
string<uri>
required
description
string
headers
object
isActive
boolean

Response

200 - application/json

Webhook

Webhook read shape. The signing secret is NOT returned on reads — it is shown only once on the create response (see CreateWebhookResponse).

id
string
required
name
string
required
url
string<uri>
required
eventType
string
required

Defaults to GENERAL. Set server-side; not accepted on create/update.

isActive
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
headers
object