Skip to main content
PATCH
/
webhooks
/
{id}
Update a webhook
curl --request PATCH \
  --url https://app.gaintrace.com/api/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [],
  "headers": {},
  "description": "<string>",
  "active": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "active": true,
    "description": "<string>",
    "headers": {},
    "secretPrefix": "<string>",
    "consecutiveFailures": 123,
    "disabledAt": "2023-11-07T05:31:56Z",
    "lastSuccessAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer API key. Secret server keys start with gt_live_; client-safe browser keys start with gt_pub_ (write-only, origin-pinned). Create and scope keys in Settings → API Keys.

Path Parameters

​
id
string
required

Resource UUID. For companies you may also pass ext:<externalId> to address by your external id.

Body

application/json

Any subset. Setting active:true also clears the auto-disable failure state.

​
url
string<uri>
Maximum string length: 500
​
events
(enum<string> | any)[]
Minimum array length: 1
Available options:
company.created,
company.updated,
contact.created,
contact.updated,
contact.deleted,
signal.created,
member.invited,
member.joined
​
headers
object
​
description
string | null
Maximum string length: 255
​
active
boolean

Response

The updated webhook.

​
data
object
Last modified on July 6, 2026