Miracle Docs
Webhooks

Rotate webhook endpoint signing secret

Generates a new signing secret for the specified endpoint. The secret and exact deadline are returned in this non-cacheable response; reusing the same Idempotency-Key safely replays them after response loss. Store the secret securely and install it during the bounded grace period. Native and strp-compatible deliveries accept both secrets during grace; adn- and chkt-compatible deliveries keep using the previous secret until the deadline.

POST
/v1/webhooks/endpoints/{id}/rotate-secret
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Header Parameters

Idempotency-Key*string

Stable key for this endpoint rotation. Reuse it to recover the same secret and deadline after response loss.

Response Body

application/json

curl -X POST "https://<api-host>/v1/webhooks/endpoints/string/rotate-secret" \  -H "Idempotency-Key: string"
{
  "data": {
    "secret": "string",
    "graceExpiresAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty
Empty

On this page