Overspeed Event

Overview

Overspeed event gets triggered when the tracker exceeds a specified speed limit.

Create overspeed event

This endpoint allows you to add an overspeed event to a tracker. When the event is triggered, notifications are sent to recipients based on the event notification configuration.

POST {baseUrl}/tracker/event

Request Body

Field	Type	Required	Description
trackerId	string	✅	The unique ID of the tracker.
eventType	string	✅	The type of event to be created. (For overspeed, use "OVER_SPEEDING_WARNING")
eventConfig	object	✅	Configuration settings for the event.
eventConfig.speedLimit	number	✅	The speed limit in km/hr) that triggers the event.
eventNotification	object	❌	Optional notification settings for the event.
eventNotification.acceptedMediums	array	❌	A list of notification channels and their settings.
eventNotification.status	string	❌	Status of the notification configuration. Accepts either "inactive" or "active"

Sample Success Data

//Sample Request Body
{
    "trackerId": "6780092e89b7bd4c6b0a82be",
    "eventType": "OVER_SPEEDING_WARNING",
    "eventConfig": {
        "speedLimit": 15
    },
    "eventNotification": { //optional
      "acceptedMediums": [
        {
          "channel": "email",
          "isEnabled": true,
          "defaultEmail": [ "[email protected]" ]
        },
        {
          "channel": "sms",
          "isEnabled": true,
          "defaultPhone": [ "[phone]" ]
        },
        {
          "channel": "inApp",
          "isEnabled": false
        }
      ],
      "status": "active"
    }
}

Sample Success Response

//Sample success response
{
    "status": true,
    "message": "Tracker event successfully created",
    "data": {}
}