Webhooks

Get a webhook endpoint

Changed on

Returns one webhook endpoint in the caller's scope (no secret material). A scope/owner mismatch is reported as 404. Requires the webhooks.manage permission.

get/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.

Response

The requested webhook endpoint.

idstring required

Webhook endpoint id.

scopeType'game' | 'league' | 'org' | 'team' | 'user' required

The single scope dimension an endpoint is bound to.

scopeIdstring required

Stringified bound scope id.

urlstring required

Delivery URL.

secretPrefixstring required

First 8 chars of the current signing secret (display only).

eventsstring[] required

Subscribed event tokens.

isActiveboolean required

Whether the endpoint receives deliveries.

labelstring nullable required

Human label, or null.

failureCountinteger required

Consecutive dead-lettered deliveries (auto-disables at 50).

lastDeliveredAtnumber nullable required

Epoch ms of the last successful delivery, or null.

lastFailedAtnumber nullable required

Epoch ms of the last failed delivery, or null.

createdAtnumber required

Creation epoch ms.

updatedAtnumber required

Last update epoch ms.

Changes