API reference · Schema
WebhookSecret
objectstringrequiredAlways `webhook_secret`: the type of this object
One of
webhook_secretwebhook_idstringrequiredID of the webhook
ID with prefix whk_
secretstringrequiredThe new signing secret. Shown only now.
previous_secret_expires_atstring (date-time) | nullrequiredTime previous secret expires (ISO 8601, UTC)
Example
{
"object": "webhook_secret",
"webhook_id": "whk_01jc5zq4m8k3v6x9t2w7r0b1e4",
"secret": "string",
"previous_secret_expires_at": "2026-01-01T00:00:00.000Z"
}Used by
- Replace the signing secret (returned once); the previous one keeps signing during the overlap
POST /v1/webhooks/{webhook_id}/rotate-secret