Skip to main content
PATCH
Modify a webhook registration, including rotating or clearing its secret.

Path Parameters

webhook_id
string<uuid>
required

Registration id to modify

Body

application/json

Request to modify an existing organization-level webhook.

Every field is optional; omitted fields are left unchanged. secret uses a nested option so the three cases stay distinguishable in one payload: absent = leave as-is, null = clear it (fall back to the deployment-wide secret), a string = replace it. Rotation is therefore a single PATCH.

Example

enabled
boolean | null

Pause or resume deliveries without deleting the registration.

headers
any

Replacement header map.

secret
string | null
write-only

Replacement secret, or an explicit null to clear it.

Minimum string length: 32
url
string | null

Replacement HTTPS URL.

Example:

"https://example.com/adaptyv/webhook-v2"

Response

Updated registration

An organization-level webhook registration as returned to the customer.

created_at
string<date-time>
required

Creation timestamp.

enabled
boolean
required

When false, this registration receives no deliveries.

headers
any
required

Extra HTTP headers sent with each delivery.

id
string<uuid>
required

Registration identifier.

Example:

"019462a4-b1c2-7def-8901-23456789abcd"

secret_set
boolean
required

Whether a signing secret is configured for this registration.

The secret itself is never returned by any endpoint. false means deliveries fall back to Adaptyv's deployment-wide secret.

updated_at
string<date-time>
required

Last-modification timestamp.

url
string
required

HTTPS URL deliveries are POSTed to.

Example:

"https://example.com/adaptyv/webhook"