In this article, we will introduce you to Push APIs, a powerful feature designed to enhance the efficiency and responsiveness of your fleet management system. Push APIs allow real-time communication between your applications and the Lynx Fleet API, ensuring that you receive immediate updates and notifications about critical events and data changes.
With Push APIs, you can streamline your operations by automating processes and reducing the need for manual data retrieval. This technology enables your system to react promptly to various triggers, such as TRU status updates, alarms, and location changes. By leveraging Push APIs, you can optimize your fleet management, improve decision-making, and enhance overall productivity.
In this article:
Overview
The Lynx Fleet Platform contains data received from multiple sources including Lynx devices on your assets. The Lynx Fleet API allows access to refrigeration unit data for integration into other applications.
Push APIs in the Lynx Fleet platform let you subscribe to updates about your assets. These updates provide timely information without needing to access the Lynx Fleet application or call Pull APIs. The data payload is encrypted and sent securely, using API keys or other authentication methods to connect with your server.
Lynx Push API sends data based on events, alarms and as new data from the telematics device (typically every 15 minutes). They deliver asset snapshots and event alerts. If you possess access to the Lynx API Portal, you may activate the Push API through that interface.
Benefits of Push API
Lynx Fleet offers both Push And Pull APIs. Push API sends data at a chosen frequency or based on events or alarms in real time. Pull API requires users or external systems to make an API request for all API data.
There are several benefits to using Push API instead of Pull API.
Real-Time Updates: Push APIs deliver information instantly as soon as it becomes available, ensuring your application always receives the most current data without delay. This is ideal for applications like live notifications, sensor monitoring, and collaborative platforms.
Reduced Network Overhead: Instead of repeatedly requesting updates, you will receive data only when relevant changes occur. This minimizes unnecessary traffic, conserves bandwidth, and reduces load on both consumers and servers.
Enhanced User Experience: Immediate data delivery enables more responsive and engaging interfaces, keeping your users informed and improving satisfaction.
Efficient Event-Driven Integration: Push APIs naturally support event-driven architectures, making it easier for you to build modular systems that react to data as soon as it arrives.
Better Scalability: Push APIs can efficiently handle many simultaneous consumers, making them well-suited for high-volume environments where timely updates are critical.
Data Available in the Push API
The Lynx Fleet Push API will send an asset snapshot. This will give you a view of the most recent state of the asset. You can also view details about the AssetSnapshot schema on the Lynx Fleet API Portal.
The snapshot data includes:
eventDateTimeUTC: Date and time that the last message for the referenced asset was collected by the telematics device.
assetInfo: Represents all information about an asset.
assetId: Lynx system unique Asset ID.
licensePlateNumber: Asset License Plate.
customFields: User Defined custom fields for the asset.
fieldId: Reference for user defined custom field.
label: Label for the user defined custom field.
value: Label for the user defined custom field.
type: type for the custom field.
status: Asset moving status, includes stop and moving.
createdDate: Asset creation date
tenantId: Asset Company ID
tenantName: Asset Company Name
deviceId: Telematics Device ID in Lynx system
sensorConfiguration: Device Sensor configurations
sensorType: Type of the sensor
Includes: NONE, AIN1, AIN2, AIN3, AIN4, DIN1, DIN1_DATACOLD, DIN2, DIN2_DATACOLD, DIN3, DIN3_DATACOLD, DIN4, DIN4_DATACOLD, BT_EN12830
configured: Indication if sensor is configured or not
sensorLocation: Installation location (Side Door, Rear Door)
Includes: NONE, SIDE, REAR, RAS1, RAS1_DATACOLD, RAS2, RAS2_DATACOLD, RAS3, RAS3_DATACOLD, SAS1, SAS1_DATACOLD, SAS2, SAS2_DATACOLD, SAS3, SAS3_DATACOLD, BOX1, BOX1_DATACOLD, BOX2, BOX2_DATACOLD, BOX3, BOX3_DATACOLD
connectionLocation: Device that the sensor is connected to
sensorData: Sensor value
statusInfo: Information on the state of the Transport Refrigeration Unit (TRU) at the time of the message
powerStatus: TRU Power Status
Will show On or Off
switchOnHours: The total accumulated hours that the TRU has been turned on
engineRunHours: The total accumulated hours that the TRU has been running on its engine
standByHours: The total accumulated hours that the TRU has been running on standby, or electric, power
batteryVoltage: The voltage of the TRU's 12V battery
batteryCurrent: Battery Current (Device)
rearDoorOpen: Indicates if the rear door on the truck or trailer is open or not
sideDoorOpen: Indicates if the side door on the truck or trailer is open or not
fuelLevel: TRU Fuel Level (%).
truStatus: Overall Status of the TRU
comp(number)OperatingMode: Operating mode of Compartment (number)
Numbers can be displayed as 1, 2 and 3
positionSpeed: Speed of the unit at the time of the message
vehicleMileage: Mileage of the unit at the time of the message
deviceBatteryPowerSupply: Battery Power Supply (Device)
deviceBatteryVoltage: Battery Voltage of the Device
movementStatus: Indicates if the unit is moving or not
enginePowerMode: TRU Power Source
Engine or Standby
engineControlMode: TRU Control Mode
Includes Continuous, Start/Stop
engineSpeed: TRU Engine Speed
Includes Engine speed High, Engine speed Low, Engine speed very Low, Engine speed very High
switchKeyStatus: Light Commercial Vehicle (LCV) switch key status
roadEnergy: LCV road energy
standByEnergy: LCV standBy Energy
powerMode: LCV power mode
temperatureInfo: Information about the temperature recordings at the time of the message
setpointTemp(number): Compartment (number) Setpoint Temperature (°C)
Numbers can be displayed as 1, 2 and 3
returnAirTemp(number): Compartment (number) Return Air Temperature (°C)
Numbers can be displayed as 1, 2 and 3
supplyAirTemp(number): Compartment (number) Supply Air Temperature (°C)
Numbers can be displayed as 1, 2 and 3
datacoldTemp(number): DataCOLD temperature sensor (number)
Numbers can be displayed as any corresponding senor number 1 through 6
oneWireTemp(number): One Wire temperature sensor (number)
Numbers can be displayed as any corresponding senor number 1 through 6
alarmInfo: An array containing AlarmInfo objects, which contains information about any TRU alarms at the time of the message.
response: indicates if alarm is a Shutdown alarm or Alarm-only.
connectedTruckInfo: An array containing ConnectedTruckInfo objects, which contain information about signal strength, licensePlate number, macId and truckName. This data is collected for assets that use trucks with beacon sensors.
Subscribing to the Push API
If you are interested in using the Lynx Fleet Push API, contact Carrier at lynx-support@carrier.com for more information. Please allow approximately 4 weeks to establish this integration. The Lynx Fleet team will work with you during that time to establish connectivity.
Push API Authorization
Lynx Push APIs use webhooks. A webhook is a method for one application to send real-time information to another application when a specific event occurs. It is an automated message sent over HTTP, enabling real-time communication between different systems. Webhooks use authentication to securely send data. Lynx Push API has four options for how to authenticate including by API key and using OAuth2.
Retry Attempts
The Lynx Push API is configured to perform up to three automatic retry attempts in case of failure. However, in case all three retries are unsuccessful, an implemented circuit breaker pattern has been put in place as a resilience strategy to allow you to have support if your target endpoint is unavailable.
Related Articles
Understanding Lynx Fleet APIs - Visit the Lynx API portal to learn how to connect your existing tools with Lynx Fleet
API FAQs - Find the answers to many of your questions about Lynx Fleet APIs
Lynx Fleet Terminology - Learn more about terminology used in the application
Have More Questions?
Contact Carrier at lynx-support@carrier.com for more information.