webhook

Rotate the webhook signing secret

Generates a new signing secret and places the previous secret into a grace/overlap window. The response contains exactly two active secrets: the new primary (expiryAt null) and the previous primary (expiryAt set to now + overlapHours). If an overlap secret is already active (a previous rotation is still within its grace window), rotation is blocked and a 409 Conflict is returned. The caller must first explicitly revoke the overlap secret via DELETE /webhook-secret/{id}, or wait for the grace window to expire, before rotating again. This ensures the active secret count never exceeds two and makes the invariant explicit rather than silently evicting secrets.

post/api/v2/webhook/{id}/rotate-secret

Request

  • Base URL
    https://central.zerotier.com
  • Auth
    HTTP bearer

Path parameters

idstring required

The webhook ID

Request body

overlapHoursinteger

How many hours the previous secret remains valid after rotation. Defaults to 24. Use 0 for an immediate hard cutover with no overlap.

Response

Webhook with the new and previous secrets

idstring required
orgIdstring required
descriptionstring
urlstring uri required

The HTTPS endpoint URL that will receive webhook events. Must be a fully-qualified domain name (FQDN) — raw IP addresses are not allowed. The domain must not resolve to private or internal IP ranges (RFC1918, loopback, link-local, etc.).

eventListstring[] required

Event types that trigger this webhook

createdAtstring date-time required
lastModifiedstring date-time required

Changes

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