Webhooks

Receive HTTP notifications when events occur in CheerKeeper.

Creating a Webhook

POST /api/webhooks
Content-Type: application/json

{
  "url": "https://your-server.com/webhook",
  "events": ["schedule.updated", "event.published"],
  "secret": "your-secret-key"
}

Available Events

Event	Description
event.created	New event created
event.updated	Event details changed
event.published	Event published to mobile
event.archived	Event archived
schedule.updated	Schedule modified
performance.created	Performance added
performance.updated	Performance changed
performance.deleted	Performance removed

Webhook Payload

{
  "event": "schedule.updated",
  "timestamp": "2025-03-15T09:00:00Z",
  "data": {
    "eventId": "event_123",
    "changes": [...]
  }
}

Verifying Webhooks

Verify the signature header:

X-CheerKeeper-Signature: sha256=...

Retry Policy

Failed deliveries retry:

• 3 attempts
• Exponential backoff
• Disabled after consecutive failures

Related Docs

• API Overview - Full API documentation