Event reference

Every event uses the same envelope (event, createdAt, companyId, data). This page lists the data for each.

Card holders

card_holder.created

A person was added in the portal, by SCIM, or by directory sync.

{ "id": "0b5e4c1a-…", "externalId": "S1024", "firstName": "Emma", "lastName": "Hall" }

SCIM and directory-sync creations send { "id": "…", "via": "scim" } style data instead of the name fields.

card_holder.updated

A person was changed in the portal, by SCIM, or by directory sync. Data is { "id": "…", "changes": { … } } for portal edits.

Caution

Changes made through the REST API (POST or PATCH /card-holders) do not currently fire these two events. They are recorded in the audit log only. If your system both writes through the API and listens for these events, you will not hear your own writes echoed back.

Photos

photo.approved / photo.rejected

Staff approved or rejected a photo.

{ "photoId": "5d1f0a52-…", "cardHolderId": "0b5e4c1a-…", "reason": null }

reason carries the rejection reason for photo.rejected.

Orders

order.submitted

An order was submitted, from the portal or by PATCH /orders/{id}.

{ "orderId": "a3e8e6f0-…", "orderNumber": "ACME-2027-0412", "cardCount": 40, "fulfilment": "self" }

order.status_changed

An order’s status changed.

{ "orderId": "a3e8e6f0-…", "orderNumber": "ACME-2027-0412", "from": "submitted", "to": "in_production" }

order.shipped

A bureau order left in a parcel.

{
  "orderId": "a3e8e6f0-…", "orderNumber": "ACME-2027-0412",
  "shipmentNumber": "SHP-0091", "carrier": "NZ Couriers",
  "trackingNumber": "NZC123456", "trackingUrl": "https://…"
}

order.completed

A bureau order was delivered and closed. Data is orderId, orderNumber and shipmentNumber.

Shipments and invoices (bureau customers)

shipment.dispatched

{
  "shipmentId": "…", "shipmentNumber": "SHP-0091", "carrier": "NZ Couriers",
  "trackingNumber": "NZC123456", "trackingUrl": "https://…",
  "orderIds": ["a3e8e6f0-…"]
}

invoice.issued

{ "invoiceId": "…", "invoiceNumber": "INV-2027-0033", "totalAmount": "1148.00", "currency": "NZD" }

Invoices raised for shipments also carry orderIds and shipmentIds.

Cards

card.issued

A card or digital credential was issued.

{ "cardId": "c2a4f0f6-…", "serialNumber": "AC-000123", "cardHolderId": "0b5e4c1a-…", "orderId": "a3e8e6f0-…" }

Digital-only issuance sends format: "digital" and a reason instead of orderId.

card.revoked

A card was reported lost, stolen or damaged, or revoked.

{ "cardId": "c2a4f0f6-…", "serialNumber": "AC-000123", "status": "lost", "reason": "Reported lost" }

Reserved events

photo.uploaded and import.completed can be subscribed to but are not sent at present. Do not build on them yet.