Skip to main content
PATCH
Update a webhook endpoint

Authorizations

x-api-key
string
header
required

Partner API key. Also accepted as Authorization: Bearer <key>.

Path Parameters

id
string
required

Webhook config ID.

Body

application/json

Provide at least one field to change.

endpoint
string<uri>

New HTTPS URL to deliver events to.

apiKey
string

Rotate the shared secret (at least 20 characters).

Minimum string length: 20
audience
enum<string>
Available options:
partner,
internal
description
string

Response

Updated webhook endpoint.

success
boolean
required
Example:

true

message
string
required
meta
object
required

Optional metadata (e.g. pagination). Empty object when not applicable.

data
object
required