Skip to main content

​
Overview

Webhooks enable real-time notifications when scores, achievements, or attestations change. This guide covers webhook setup and best practices.

​
Setting Up Webhooks

curl -X POST https://api-mainnet.onzks.com/api/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/zkscore",
    "events": ["score.updated", "achievement.claimed"],
    "secret": "your_webhook_secret"
  }'

​
Best Practices

  1. Verify Signatures: Always verify webhook signatures
  2. Idempotency: Handle duplicate events
  3. Async Processing: Process webhooks asynchronously
  4. Monitoring: Monitor webhook delivery
  5. Error Handling: Retry failed webhooks