Skip to main content
POST
/
webhooks
/
{id}
/
test
curl -X POST https://teambattles.gg/api/v1/webhooks/wh_abc123/test \
  -H "Authorization: Bearer tb_your_api_key"

{
  "delivered": 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. This route also consumes the per-endpoint token bucket: when it is exhausted you receive 429 error_api_rate_limited with X-RateLimit headers.

​
What’s Returned

Returns { delivered }, a boolean reporting whether the test.ping returned a 2xx. The raw target status code and error are deliberately not echoed back; read the full outcome from the delivery log via List A Webhook Endpoint’s Deliveries. The test sends one signed test.ping with no retries and logs a single test delivery row.
Use the test.ping to confirm your endpoint verifies the Standard Webhooks webhook-id / webhook-timestamp / webhook-signature headers correctly. For the full signature scheme and event catalog, see the Webhooks guide.
curl -X POST https://teambattles.gg/api/v1/webhooks/wh_abc123/test \
  -H "Authorization: Bearer tb_your_api_key"

Authorizations

​
Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Path Parameters

​
id
string
required

Webhook endpoint id.

Response

The test delivery outcome.

Outcome of a single test.ping delivery.

​
delivered
boolean
required

Whether the test.ping returned a 2xx. The raw status code and error are not echoed; read the delivery log for details.