Skip to main content
PATCH
Update a webhook endpoint

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Path Parameters

id
string
required

The endpoint id (whe_…).

Example:

"whe_0192b5c4e7a87c3e9d1f2a6b4c8e0d13"

Body

application/json
url
string
Maximum string length: 2048
eventTypes
string[]
filters
object
description
string | null
Maximum string length: 255
status
enum<string>

"disabled" stops deliveries to the endpoint; "active" starts them again.

Available options:
active,
disabled

Response

success
boolean
required
Example:

true

message
string
required
Example:

"WEBHOOK_FETCHED"

data
object
required