GaugeAPI docs
GuidesAPI referenceChangelogOpen console
API referenceWebhooks

Update a webhook endpoint

PATCH
/v2/webhook-endpoints/{id}

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

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.

Request Body

application/json
  1. body
url?string
Formaturi
Lengthlength <= 2048
events?array<>
Items1 <= items
connectionIds?array<>|
Items1 <= items <= 50
projectId?|
Formatuuid
apiVersion?"2026-10-21"
Value in"2026-10-21"
enabled?boolean

Response Body

The updated endpoint.

application/json
  1. response
id*string
Formatuuid
url*string
events*array<string>

Exact event names, family.* prefixes, or *.

connectionIds*array<>|

Only events on these connections; null for every connection.

projectId*|

Only events of this App; null for every App and none.

Formatuuid
apiVersion*|

The payload version. Null on endpoints created before API v2 (support events only).

enabled*boolean
disabledReason*|

Set when Gauge switched the endpoint off after failing for days.

Value in"consecutive_failures"
disabledAt*|
Formatdate-time
ownerMemberId*|

Whose visibility the endpoint has: it only receives conversations this member can see.

Formatuuid
createdAt*string
Formatdate-time
secretRotatedAt*|
Formatdate-time
previousSecretExpiresAt*|
Formatdate-time
lastDeliveryStatus*|
Value in"pending""delivering""delivered""failed""dead"
lastDeliveryAt*|
Formatdate-time
successRate24h*|
Range0 <= value <= 1
Example Request
curl -X PATCH 'https://app.gauge.chat/backend/v2/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "url": "string",  "events": [    "string"  ],  "connectionIds": [    "727129f8-6680-44ef-a207-d136cf0c29f0"  ],  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",  "apiVersion": "string",  "enabled": true,  "disabledReason": "consecutive_failures",  "disabledAt": "2019-08-24T14:15:22Z",  "ownerMemberId": "a8961912-4bf3-4418-9ed8-fe7fa367bf97",  "createdAt": "2019-08-24T14:15:22Z",  "secretRotatedAt": "2019-08-24T14:15:22Z",  "previousSecretExpiresAt": "2019-08-24T14:15:22Z",  "lastDeliveryStatus": "pending",  "lastDeliveryAt": "2019-08-24T14:15:22Z",  "successRate24h": 0}

Send a test event POST

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

call.completed Webhook

A call ended: answered, missed, failed, or sent to voicemail. Sent only for calls the endpoint owner can see in call history (their numbers, calls they handled, their teams’ and queues’ calls; Owners and Admins see all). Endpoints on API version 2026-10-21 or later.