Skip to main content
PATCH
Update a webhook endpoint

Path Parameters

endpointId
string<uuid>
required

The webhook endpoint ID.

Body

application/json

At least one field is required; omitted fields keep their stored values.

url
string
Maximum string length: 500
description
string
Maximum string length: 200
eventTypes
enum<string>[]
Maximum array length: 32
Available options:
business.created,
business.onboarding_completed,
business_membership.created,
book_version.published,
book_publication.rolled_back,
quote_intent.requires_input,
quote_intent.succeeded,
quote_intent.failed
status
enum<string>
Available options:
active,
disabled

Response

The updated endpoint.

data
object
required

Endpoint metadata. Signing secrets are never retrievable after creation/rotation.

requestId
string
required