Skip to main content
POST
cURL
Generate a fresh signing secret for a webhook. The response includes the new secret once, so copy it immediately. The old secret stops working the moment this call returns. Deploy the new secret to your verification code before you rotate.
Rotate right away if a secret leaks (committed to git, exposed in a log, sent in a screenshot). Use Idempotency-Key when retrying a rotate after a timeout. A matching retry returns the same one-time secret response instead of rotating again.

Authorizations

Authorization
string
header
required

API key authentication. Send your key in the Authorization header as Bearer oxi_sk_live_.... Live keys require an active Pro subscription and return live data.

Headers

Idempotency-Key
string

Optional safe-retry key. Reuse the same value only when retrying the exact same mutation request body; a different body returns 422 and an in-flight matching request returns 409.

Required string length: 1 - 255

Path Parameters

id
integer<int64>
required

Webhook endpoint id owned by the authenticated API key user.

Response

Webhook destination

object
string
required
Allowed value: "webhook"
data
object
required
meta
object
required