Vehicle Pairing

The VEHICLE_PAIRING event is triggered when a Bluetooth beacon is detected within the vehicle’s proximity, indicating a successful pairing between the beacon and the vehicle. This event also handles unpairing detection when the beacon moves out of range, signaling that the connection has been lost.

Event Type: VEHICLE_PAIRING

Trigger Condition

A webhook must be subscribed to the VEHICLE_PAIRING event.
When a Bluetooth beacon is detected within the vehicle’s vicinity, a Vehicle Pair event is triggered.
When the beacon is no longer detected within the vehicle’s vicinity, a Vehicle Unpair event is triggered.

Example Payload

{
  "eventInfo": {
    "driverId": "8a94aa04-1111-3333-0197-eb08f9916b51",
    "actionBy": "8a9388a8-2222-4444-018c-19735e2e2d05",
    "name": null,
    "eventTime": 1751994924519
  },
  "messageType": "VEHICLE_PAIRING",
  "entityName": "GMC 1111",
  "customerId": 12345,
  "action": "Pair",
  "entityId": "3d3120cd-1111-2222-b54a-198d1339ead5",
  "time": 1751994923960
}

Reference

Field	Description
driverId String,UUID	Unique ID of the driver involved in the pairing event. Example: "8a94aa04-1111-3333-0197-eb08f9916b51"
actionBy String,UUID	ID of the user or system initiating the event. Example: "8a9388a8-2222-4444-018c-19735e2e2d05"
eventTime TimeStamp	Timestamp (in milliseconds) when the event occurred. Example: 1751994924519
messageType String	Type of event message. Example: `"VEHICLE_PAIRING"`
entityName String	Name of the vehicle involved in the pairing/unpairing event. Example:`GMC 111`
customerId Long	Unique customer ID associated with the event. Example:`12345`
action String	Indicates the action performed. Example:`Pair`
entityId String,UUID	Unique identifier of the vehicle entity. This is automatically generated when the Vehicle object is created and cannot be altered. Example: `3d3120cd-1111-2222-b54a-198d1339ead5`
time Time Stamp	Timestamp (in milliseconds) when the message was generated. Example:`1751994923960`