Skip to main content

Scan events

Receive both successful and failed pass scans. The scan payload includes the result, reason, location, timestamp, and available member information. The member may be null for a scan without a linked member.

Ticket check-ins are emitted once per successful redemption scan. Rejected scans only produce scan.created.

Scan​

EventWhen it is sent
scan.createdA pass scan is recorded, whether successful or failed

Example payload​

This example illustrates scan.created. Available fields depend on the resource and the action.

{
"id": "evt_example",
"event": "scan.created",
"timestamp": "2030-05-01T18:00:00.000Z",
"organisation_id": "507f1f77bcf86cd799439010",
"schema_version": "1",
"source": "admin",
"data": {
"scan": {
"id": "507f1f77bcf86cd799439011",
"company": "507f1f77bcf86cd799439010",
"source": "web",
"member": {
"id": "507f1f77bcf86cd799439011",
"name": "Example Member",
"email": "member@example.com",
"memberId": "MEM001"
},
"input": "EXAMPLE",
"result": "success",
"timestamp": "2030-05-01T18:00:00.000Z"
}
}
}

See delivery and security for the shared envelope, signature verification, retry behavior, and delivery guarantees. Use subscription management to preview sample data for every supported event and send test deliveries.