Webhooks

Send a test.ping to a webhook endpoint

Changed on

Sends a single signed test.ping delivery (no retries) and logs it. Use it to verify your endpoint and signature handling. Requires the webhooks.manage permission; league-scoped endpoints additionally require current league ADMIN membership and the webhooks feature on the league owner's plan.

post/webhooks/{id}/test

Request

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

Path parameters

idstring required

Webhook endpoint id.

Response

The test delivery outcome.

deliveredboolean required

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

Changes