No Movement Event

Overview

No movement event gets triggered when no movement is detected for a specified period.

Create no movement event

This endpoint allows you to add a no movement 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 no movement event, use "NO_MOVEMENT_ALERT")

eventConfig

object

Configuration settings for the event.

eventConfig.minimumParkingDuration

number

The delay (in minutes) before the event is triggered after it stops.

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": "NO_MOVEMENT_ALERT",
    "eventConfig": {
        "minimumParkingDuration": 15
    },
    "eventNotification": { //optional
      "acceptedMediums": [
        {
          "channel": "email",
          "isEnabled": true,
          "defaultEmail": [ "[email protected]" ]
        },
        {
          "channel": "sms",
          "isEnabled": true,
          "defaultPhone": [ "+2349088888888" ]
        },
        {
          "channel": "inApp",
          "isEnabled": false
        }
      ],
      "status": "active"
    }
}

Sample Success Response

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

Last updated