Webhooks

Create a webhook endpoint

Changed on

Creates a webhook endpoint. By default it is bound to the API key's derived scope (a personal key scopes to your user, a developer-app key to its game). Pass leagueId to create a league-scoped endpoint instead: you must be a current ADMIN of that league, and the league owner's plan must include the webhooks feature. Returns the signing secret ONCE. Requires the webhooks.manage permission and the webhooks feature.

post/webhooks

Request

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

Request body

urlstring required

HTTPS endpoint URL. Private/loopback/metadata hosts are rejected.

eventsstring[] required

Subscribed event tokens: exact catalog names (e.g. match.completed) or family wildcards (e.g. match.*). At least one required.

labelstring

Optional human label for the endpoint.

leagueIdstring

League id - creates a league-scoped endpoint; requires current league ADMIN membership; gated on the league owner's plan.

Response

The created endpoint's id and one-time signing secret.

idstring required

The endpoint id the secret belongs to.

signingSecretstring required

Plaintext signing secret. Shown ONCE - store it now.

secretPrefixstring required

First 8 chars of the new signing secret.

Changes