Rotate a webhook signing secret

Mint a new active signing secret (returned ONCE) and deprecate the current one for a grace period during which both are used to sign, so the receiver can swap without dropping deliveries.

post/v1/webhooks/applications/{appId}/endpoints/{id}/rotate-secret

Request

Base URL: https://api.prod.keyban.io
URL: https://api.prod.keyban.io/v1/webhooks/applications/{appId}/endpoints/{id}/rotate-secret
Auth: API key in header X-Api-Key

Path parameters

appIdstring required

idstring required

Response

The endpoint with its new signing secret (shown once)

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

applicationIdstring uuid required

Application (tenant) that owns this endpoint.

urlstring uri required

HTTPS URL that receives the deliveries.

eventTypesstring[] required

Event types this endpoint is subscribed to.

enabledboolean required

Whether deliveries are currently sent to this endpoint.

secretstring required

Standard Webhooks signing secret (whsec_<base64>). Returned ONCE at creation or rotation and never again — store it now. The receiver verifies the webhook-signature header with it (e.g. the standardwebhooks library).

Example response

{
  "applicationId": "550e8400-e29b-41d4-a716-446655440000",
  "url": "https://api.example.com/hooks/keyban",
  "eventTypes": [
    "dpp.passport.updated"
  ],
  "enabled": true,
  "secret": "whsec_MfKQ9rG3xX0m9V2s1qv4b7Yc8d0e2f4g"
}

Changes

No recorded changes to this operation across all 1 revision of this API.