API referenceWebhooks

Rotate the signing secret

POST
/v2/webhook-endpoints/{id}/rotate-secret

Returns the new secret ONCE. With overlapHours: 24 the old secret keeps signing a second v1 in Gauge-Signature for a day.

Authorization

ApiKey
headerAuthorizationBearer <token>

An API key from Developers → API keys: Authorization: Bearer gauge_live_… (or pulse_k_live_…).

Path Parameters

id*string

The webhook endpoint id.

Formatuuid

Header Parameters

Gauge-Version?string

A dated version. Default 2026-10-21.

Idempotency-Key*string

Required on every POST. Retries with the same key replay the first response for 24 h.

Length1 <= length <= 255

Request Body

application/json
  1. body
overlapHours?|

How long the old secret keeps signing (a second v1).

Default24

Response Body

The new secret.

application/json
  1. response
secret*string

The new signing secret. Shown once.

previousSecretExpiresAt*|
Formatdate-time
Example Request
curl -X POST 'https://app.gauge.chat/backend/v2/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/rotate-secret' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "secret": "string",  "previousSecretExpiresAt": "2019-08-24T14:15:22Z"}