Event Catalogue

this page lists all event types currently emitted by be-in and their payload shapes.

entry.recorded

emitted when a user scans a qr code at a pod and gains entry. this is the primary event type for integration partners.

{
  "request_id": "bein_8N1r6W2XK", // your original request id
  "pod_id": "uuid", // which pod was scanned
  "scanned_at": "2024-05-31T12:35:02.789Z",
  "metadata": {
    /* your original metadata from the qr-code request */
    "external_user_id": "abc-123",
    "purpose": "guest-pass",
  },
}

field descriptions

• request_id – the identifier generated when you created the qr code
• pod_id – uuid of the pod hardware that was scanned
• scanned_at – iso-8601 timestamp of when the scan occurred
• metadata – the exact json object you provided when generating the qr code

future events

additional event types (subscription updates, cancellations, etc.) may be added in future versions. the webhook system is designed to be extensible.

ℹ️ the definitive list can always be fetched from the api: GET /v1/webhooks/events.