Request Custom Event

Tested

PUT

/events/custom_event

Endpoint to request custom event for device with ID device_id starting at start_ts.

If not specified, the following parameters will use their default values:

Param	Default Value
`duration`	30 secs
`media_type`	all

if media_type=all then request will return a snapshot for start_ts and video for start_ts + duration;

if media_type=video then request will return a video for start_ts + duration;

if media_type=snapshot then request will return a snapshot for start_ts.

User Role Permissions

The following table shows which user roles are allowed to send requests using this API endpoint.

Role	Permission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Body Params multipart/form-data

Responses

🟢200Success

application/json

Body

🟠400Invalid datetime format

🟠401Login Required

🟠404Resource Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/events/custom_event' \
--form 'device_id=""' \
--form 'start_ts=""' \
--form 'duration=""' \
--form 'display_name=""' \
--form 'data=""' \
--form 'geotab_user_id=""' \
--form 'media_type=""'

Response Example

200 - Success (Device is NOT offline/sleep and request does NOT exist)

{
    "meta": {
        "code": 200
    },
    "response": {
        "event_id": 1924553
    },
    "result": "OK"
}

Modified at 2025-11-04 14:39:55

Get unknown driver trips

Get Company Events

Request Custom Event

User Role Permissions#

Request

Responses

User Role Permissions