Webhook endpoints

Rotate the signing secret

POST/v1/webhooks/{endpoint_id}/secret

Generates a new signing secret (shown once). The previous secret stops signing immediately.

Required scopewrite:webhooks

Rate limit60 requests per minute

curl -X POST 'https://api.fansquare.so/v1/webhooks/67a55c69-e54b-4b90-a9f9-e000f12eb3fd/secret' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "secret": "fsq_whsec_pBZQSjuC8yWOLOpRucfKjAkCRfDiZtNu",
  "secret_prefix": "fsq_whsec_pBZQSj"
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Path

endpoint_idstringrequired
Webhook endpoint id (the id field of endpoint items).
format uuid

Response

OK, application/json

secretstringrequired
New signing secret, shown ONCE: store it now.
secret_prefixstringrequired
First characters of the new secret, as returned by GET /v1/webhooks.

curl -X POST 'https://api.fansquare.so/v1/webhooks/67a55c69-e54b-4b90-a9f9-e000f12eb3fd/secret' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "secret": "fsq_whsec_pBZQSjuC8yWOLOpRucfKjAkCRfDiZtNu",
  "secret_prefix": "fsq_whsec_pBZQSj"
}