Skip to main content
PATCH
/
webhooks
/
{id}
curl -X PATCH https://teambattles.gg/api/v1/webhooks/wh_abc123 \
  -H "Authorization: Bearer tb_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"events":["match.*","score.*"],"isActive":true}'

{
  "ok": true
}

​
Permission Required

This endpoint requires the webhooks.manage permission (the { kind: "webhook" } scope) on your API key, plus the webhooks feature. Webhooks are gated to api_pro or higher plans: a key on a free plan receives 403 error_api_feature_required.

​
Access / Membership Rules

Webhooks are owner-scoped. The {id} must resolve to an endpoint in your key’s own derived scope (user, game, or league, depending on your key type). An endpoint owned by another scope - or an unknown id - is reported as 404 error_webhook_not_found.

​
What’s Returned

Returns { "ok": true } on success. Re-enabling the endpoint (isActive: true) or changing its url resets the consecutive failure count.

​
Request Body

All fields are optional - send only the ones you want to change. At least one field should be supplied.
FieldTypeRequiredDescription
urlstringNoNew HTTPS delivery URL.
eventsstring[]NoReplacement event token list (at least one entry when present).
labelstringNoNew human-readable label.
isActivebooleanNoEnable or disable the endpoint. Re-enabling resets the failure count.
For the signature scheme, request headers, and the full event catalog, see the Webhooks guide.
curl -X PATCH https://teambattles.gg/api/v1/webhooks/wh_abc123 \
  -H "Authorization: Bearer tb_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"events":["match.*","score.*"],"isActive":true}'

Authorizations

​
Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Path Parameters

​
id
string
required

Webhook endpoint id.

Body

application/json

Partial update of a webhook endpoint.

​
url
string

New HTTPS endpoint URL.

​
events
string[]

Replacement event token list (at least one when present).

Minimum array length: 1
​
label
string

New human label.

​
isActive
boolean

Enable/disable the endpoint. Re-enabling resets the failure count.

Response

Update acknowledged.

Success ack.

​
ok
boolean
required