Webhooks

Receive real-time notifications when events occur in your CirculeID account.

Available Events

passport.created

Triggered when a new passport is created

passport.updated

Triggered when a passport is updated

passport.scanned

Triggered when a passport QR code is scanned

passport.verified

Triggered when a passport is verified

Webhook Payload Example

{
  "event": "passport.scanned",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "passportId": "passport_abc123",
    "productId": "SKU-12345",
    "location": "New York, USA",
    "scanCount": 1248
  }
}