Webhook endpoints

Send a test delivery

POST/v1/webhooks/{endpoint_id}/ping

Queues a signed ping delivery through the real pipeline (same worker, signature and egress IP as production events).

Required scopewrite:webhooks

Rate limit10 requests per minute

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

{
  "status": "queued",
  "event_id": "4117a4c7-1ff6-4b33-a952-dd5ad1b2a4ad"
}

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

Accepted, application/json

status"queued"required
The delivery is queued.
event_idstringrequired
id of the ping event, as it will appear in the delivered envelope.

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

{
  "status": "queued",
  "event_id": "4117a4c7-1ff6-4b33-a952-dd5ad1b2a4ad"
}