Skip to main content
POST
Register a webhook for the organization.

Body

application/json

Request to register an organization-level webhook.

Example

url
string
required

HTTPS URL to deliver to. Must be publicly routable.

Receives the events of every experiment in the organization that has not registered a webhook of its own; an experiment that has one delivers only there, not here as well.

Example:

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

headers
any

Extra HTTP headers to send with each delivery.

secret
string | null
write-only

HMAC signing secret. Write-only — it is never returned again, so keep your copy. Omit to inherit Adaptyv's deployment-wide secret.

Minimum 32 characters.

Minimum string length: 32
Example:

"a-32-plus-character-shared-secret"

Response

Webhook registered

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"