Webhooks

Rotate a webhook signing secret

Changed on

Rotates the endpoint's signing secret. The previous secret keeps signing for a 24h grace window so consumers can update without missing deliveries. Returns the new secret ONCE. 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}/rotate-secret

Request

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

Path parameters

idstring required

Webhook endpoint id.

Response

The new 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