Webhooks

Update a webhook endpoint

Changed on

Partially updates a webhook endpoint in the caller's scope. Re-enabling or changing the URL resets the failure count. Requires the webhooks.manage permission; league-scoped endpoints additionally require current league ADMIN membership and the webhooks feature on the league owner's plan.

patch/webhooks/{id}

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Webhook endpoint id.

Request body

urlstring

New HTTPS endpoint URL.

eventsstring[]

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

labelstring

New human label.

isActiveboolean

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

Response

Update acknowledged.

okboolean required

Changes