Webhooks

Rotate the signing secret

Issues a new HMAC secret for the endpoint. The new secret is returned once — update your server immediately. All future deliveries will use the new secret.

post/v1/webhooks/{id}/rotate-secret

Request

Base URL: https://api.signvoy.com
URL: https://api.signvoy.com/v1/webhooks/{id}/rotate-secret
Auth: one of:
- API key in header X-Workspace-Id
- HTTP bearer
- HTTP bearer

Path parameters

idstring required

Webhook endpoint ID

Response

New secret (shown once)

idstring uuid required

workspaceIdstring uuid required

urlstring uri required

HTTPS URL Signvoy will POST events to

descriptionobject

Human-readable label

enabledEventsstring[] required

Subscribed events. Empty array = all events.

status'enabled' | 'disabled' required

consecutiveFailuresinteger required

Count of consecutive delivery failures

disabledAtstring date-time nullable

successRateinteger nullable

Percentage of successful deliveries (null if no deliveries yet)

createdAtstring date-time required

updatedAtstring date-time required

secretstring required

HMAC-SHA256 signing secret. Shown only once — store it securely. Use it to verify the Signvoy-Signature header on inbound events.

Example response

{
  "enabledEvents": [
    "document.completed",
    "document.declined"
  ],
  "secret": "whsec_abc123..."
}

Changes

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