GaugeAPI docs
GuidesAPI referenceChangelogOpen console
API referenceWebhooks

Send a test event

POST
/v2/webhook-endpoints/{id}/test

Signs and sends a sample of a catalogue event (test: true, livemode: false) now, and reports what the endpoint answered.

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
event?string

A catalogue event to send a sample of, or webhook.test.

Length1 <= length <= 128
Default"webhook.test"

Response Body

The outcome.

application/json
  1. response
delivered*boolean
responseCode*integer|null
deliveryId*|
Formatuuid
event*string
latencyMs*|
Range0 <= value
error*string|null
Example Request
curl -X POST 'https://app.gauge.chat/backend/v2/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/test' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "delivered": true,  "responseCode": 0,  "deliveryId": "73dc828d-801d-4d29-b7e4-e046662a5901",  "event": "string",  "latencyMs": 0,  "error": "string"}

Rotate the signing secret POST

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

Update a webhook endpoint PATCH

Change the URL, events, connection or App filter, version, or turn it on or off. Turning it on clears an automatic switch-off.