Skip to main content
POST
Rotate Webhook Endpoint Secret

Авторизации

X-API-Key
string
header
обязательно

Параметры пути

id
string
обязательно

Endpoint id (UUID) whose secret is rotated.

Тело

application/json
id
string
обязательно

Endpoint id (UUID) whose secret is rotated.

grace_seconds
integer<int32>

How long the previous secret keeps signing deliveries, in seconds. Omit for the 86400-second (24 hour) default. Pass 0 to drop the previous secret at once — the right choice when it leaked, because a graceful rotation leaves a leaked secret able to forge deliveries for the whole window.

Ответ

OK

endpoint
object

The endpoint after rotation; previous_secret_expires_at bounds the window in which the old secret still signs deliveries.

secret
string
read-only

The new signing secret. Shown once — store it now.