RoscoLive API v1.0
  1. Event
RoscoLive API v1.0
  • Authentication
    • Login
    • Logout
    • mark eula as viewed
    • password change
    • password reset
  • Company
    • Get Camera Health Errors for Company
    • create a company
    • get partner settings
    • get audit logs of a company
    • get input sensors notifications of a company
    • get ignition notifications of a company
    • get a company by ID
    • update a company by ID
    • update company
    • search companies
    • get companies list
    • get a company
    • get companies
    • get partner companies list
    • get own partner company
  • Custom Role Permissions
    • get full list of available custom user permission
  • Device
    • get company devices
    • search devices
    • update a device
    • get a device data usage
    • Play in-cab audible alert sound for device
    • get devices data usage
    • get a company devices by company ID
    • restart a device
    • get company devices with modems
    • get distance
    • get installed report of a device
    • get an installed report
    • merge profile with device config
    • get audit logs of a device
    • get list of trip dates for device
    • get list of trips for passed device and date
    • Get a device
    • get list of company devices
    • get device with driver id
    • create devices (legacy/DV4)
    • create devices (auto-prov/DV6)
    • get company device using IMEI/SN
    • check red bubble in manage vehicles
    • bulk device creation
    • get devices for all companies available for user
    • get list of trip related snapshots
    • reset status of sd card
    • get list of all available dates
    • get available video list for date
    • replace device
    • get replace history by device id
    • clear device channel status
    • get camera health error by device id
    • get camera health definitions
    • update camera health error by error id
    • update camera health errors
    • Get device list for multiple companies
    • Get current activity status of devices
  • Device Firmware
    • get available firmware versions
    • get list of latest firmware versions
    • push firmware to device
    • cancel pending firmware update to devices
    • get firmware updates history for company
  • Driver Scoring / Coaching
    • get company drivers list
    • get a list of trips
    • associate a driver with a trip
    • get driver by event_id
    • update a driver
    • get driver by trip_photo_id
    • get driver scores
    • add driver photo
    • Add New Driver to Company
    • remove a driver
    • upload a driver from csv file
    • get unknown driver trips
    • associate trip with the driver.
    • Get company event score weights
    • Update company event score weights
    • Get drivers coaching events
  • Event
    • Request Custom Snapshots for Time Range
      PUT
    • Request Custom Event
      PUT
    • Get an Event of a Device by Start Time
      GET
    • Get an Event by ID and Storage Type
      GET
    • Get Company Events
      GET
    • Get Event by Company and ID
      GET
    • send an event
      PUT
    • get status of an event
      GET
    • Request videos of an event
      PUT
    • Get Uploaded Event Videos
      GET
    • get events summary of devices
      GET
    • get events summary of a device
      GET
    • get a company events by company ID
      GET
    • get status of an event by company ID
      GET
    • Get Event Snapshots
      GET
    • get snapshots of an event or alert by company ID
      GET
    • get a last event
      GET
    • Get Latest Event for Each Device in Company
      GET
    • get events log of a device
      GET
    • get dates of events
      GET
    • get events for charts and graphs
      GET
    • get events for charts and graphs by company ID
      GET
    • get an event by company ID
      GET
    • get events summary of a device by company ID
      GET
    • request videos of an event by company ID
      PUT
    • get dates of an events by company ID
      GET
    • get a last event of company device
      GET
    • clear last event
      DELETE
    • get dates of events of a device
      GET
    • Update Custom Event
      POST
    • delete an event
      DELETE
    • request videos of an alert
      PUT
    • share an event
      PUT
    • get an event by a permalink
      GET
    • get geotab events
      GET
    • get a last updated event of devices
      GET
    • download a blocked event
      POST
    • Get Flagged Company Events
      GET
    • flag an event
      PUT
    • unflag an event
      DELETE
    • generate snapshots
      PUT
    • local geocoding service
      GET
    • update an event
      POST
    • get snapshot/location of event
      GET
    • Get Device Events for Period
      GET
    • Request custom video from device
      PUT
    • get snapshot on demand
      GET
    • get an event by a permalink hash
      GET
    • Set Event Label for Event
      POST
    • Restore event video from archive
      POST
    • Add users for notification of event restore from archive
      POST
    • Add event label
      POST
    • Add user feedback to event
      POST
    • Get event user feedback
      GET
    • Get event filters list for date range in company
      GET
  • External Service
    • Get an external service account
    • Pair RL device with external device
    • Get RL device data via external device unique serial number
    • external service login
    • get a device
  • Fleet Configuration
    • Get profiles of a company
    • Create new profile in a company
    • Get a company profile
    • get profile history
    • Update a company profile
  • Group
    • get company groups
    • add a group
    • remove a group
    • get devices of a group
    • add a device to a group
    • remove a device from a group
    • get users of a group
    • add a user to a group
    • remove a user from a group
    • get company groups by company ID
    • add a device to a group by company ID
    • get devices of a group by company ID
    • remove a device from a group by company ID
    • remove a group by company ID
    • add a group by company ID
    • add an user to a group by company ID
    • get users of a group by company ID
    • remove an user from a group by company ID
    • edit group
    • get groups with ID
    • get group of a company by group ID
  • Live streaming
    • start live streaming
    • stop live streaming
    • start multi-channel live streaming
    • stop multi-channel live streaming
  • Metadata
    • get metadata of a device
    • get metadata of devices
    • Get alerts and events of devices for company
    • get alerts for charts and graphs
    • get metadata of device(s) for last 24 hours
    • get alerts of a device
    • get alerts of a driver
  • Modem Administration
    • get list of available modems
    • upgrade modem firmware
    • upgrade modem firmware for group of devices
  • Report
    • get data usage report
    • Get custom report data
    • get data usage report by device id
    • get list of companies with data usage for date range
    • get data usage for active devices for specified companies
    • get companies with data usage for date range
    • get data usage report for devices in company
    • get data tracking report
    • get all events report
    • Get all events report for company
    • get vehicle activity report
    • get firmware report
    • Get event count summary report for company devices
    • get driver event breakdown report
    • get driver event performance report
    • Update custom report
    • get custom reports by user email
    • get custom report by report id
    • put subscribe to a report
    • get report subscriptions
    • get list of standard reports
    • get speeding summary report
    • get speeding breakdown report
    • get idling summary report
    • get idling breakdown report
    • Create custom report for user
  • Partner Portal
    • get full list of devices per partner
    • get full list of companies per partner
    • get user custom presets
    • create custom presets
    • update custom preset
    • delete custom preset by name
  • Releases
    • get last release
    • view a release
  • Remote Device Management
    • get config values from device
    • verify of device token
    • get current firmware of devices
    • SD-card formatting
    • get config file for device
  • Statistics
    • get statistics feature usage
  • User
    • Get Company Users
    • Get User Info from Email Address
    • Update a User's Info
    • remove a user
    • Get my Own User Info
    • Create a User
    • Get Users by Company ID
    • get user settings
    • set user settings
    • Get application notifications
    • remove the notification
    • mark notifications as viewed
    • verify password
    • SD card reformat reminder
    • Update notification by email
    • assign user to company
    • get permissions by a user_id
    • Get event / sms notification settings
  • Webhooks
    • Add Webhook Subscription to Multiple Event Types
    • Get Notification Subscriptions for Event Type
    • Set Notifications for Event Type
    • Remove Notification Subscription for Event Type
    • Get All Webhook Subscriptions for a Company
    • Delete Webhook Subscription
  1. Event

Update Custom Event

POST
/event/{event_id}/custom_event_type
Update a custom event of ID event_id within company company_name.
If the event_id does not exist a 404 error is returned.

User Role Permissions#

The following table shows which user roles are allowed to send requests using this API endpoint.
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Path Params
event_id
integer 
required
Unique record identifier for event
>= 9<= 10
Example:
123456789
Body Params multipart/form-data
description
string  | null 
required
A string value for user to leave a note on an event. By passing an empty string the note value is cleared.
company_name
string 
required
Name displayed for company on RoscoLive
has_review
boolean 
optional
A flag for marking an event as reviewed and containing a note passed in from description value.
Note: Only customer_service, system_admin, partner, fleet_manager, custom_partner roles have access to change the has_review value. In case when API was called from the Geotab side then User role can update has_review as well

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://fleet.roscolive.com/api/v1.0/event/123456789/custom_event_type' \
--form 'description=""' \
--form 'company_name=""' \
--form 'has_review=""'

Responses

🟢200Success
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by server
>= 199<= 599
response
object (Event schema) 
required
Contains response data
accurate_duration
integer  | null 
required
Calculated event duration
>= 0<= 60
archive
string  | null 
required
If event archived, will return "archived" - otherwise null
company_id
integer 
required
ID of company
created_by
integer  | null 
optional
User ID that created this event. Only populated when custom event.
createtime
string <date-time>
required
Timestamp event was created
custom_event_type
string  | null 
optional
A field for typing custom events
device_id
string 
required
Unique ID of device
driver_name
string  | null 
optional
Name of driver
driver_email
string  | null 
optional
Email address of driver
driver_id
string  | null 
optional
Unique ID of driver
duration
integer 
required
Expected duration of event
>= 0<= 60
end_ts
string <date-time>
required
End time of event video
event_label
required
event_type
string 
required
Event Type - values can include:
{user_role}_CLIP
Distraction
Drowsiness
FatalGSensor (High G-Force)
FollowingDistanceWarning
ForwardCollisionWarning
GEOTAB_EVENT
HarshAccel
HarshBraking
InputSensor5 (DV4 Driver Event)
InputSensor9 (DV6 Driver Event / DV4 External Driver Event)
LaneDeparture
PedestrianWarning
PhoneUse
Seatbelt
Smoking
Yawning
event_display_type
string 
required
Display event type if set for custom event
flagged
boolean 
required
Flag for if event is flagged
feedback
required
Feedback object returned if query param for feedback is included.
groups
array[string]
required
Array list of groups the device is a member of
geotab_driver
string  | null 
optional
Geotab driver name
id
integer 
required
Event ID
>= 0
impact_score
boolean 
required
If event type impacts driver score
last_viewed
object 
required
Information about last viewer of event
meta_json
required
If event contains metadata json
mp4_1
required
If event video for channel 1 available
mp4_2
required
If event video for channel 2 available
mp4_3
required
If event video for channel 3 available
mp4_4
required
If event video for channel 4 available
nvr_filename
required
Filename of NVR video file
old_device_id
required
If device migrated, old device ID from migration
request_ts
string <date-time> | null 
required
The datetime event requested to be retrieved from archive - otherwise null
restored_user_id
string 
optional
User ID of user that requested event restore
restoring_start_ts
string <date-time>
optional
Timestamp when event restore was initiated
rule
optional
Geotab rule name
size
optional
File size in MB
snapshots
object 
required
An object containing snapshots returned for active channels during event
snapshot_status
string 
optional
Upload status of snapshots
start_ts
string <date-time>
required
Start time of event video
status
string 
required
Status of event
timestamp
string <date-time>
required
Time when event was triggered in video
type
string 
required
Event Type - values can include:- {user_role}_CLIP- Distraction- Drowsiness- FatalGSensor (High G-Force)- FollowingDistanceWarning- ForwardCollisionWarning- GEOTAB_EVENT- HarshAccel- HarshBraking- InputSensor5 (DV4 Driver Event)- InputSensor9 (DV6 Driver Event / DV4 External Driver Event)- LaneDeparture- PedestrianWarning- PhoneUse- Seatbelt- Smoking- Yawning
uploaded_timestamp
required
Timestamp when event video was uploaded
uploading_status
enum<string>  | enum<null> 
required
Allowed values:
EVENT_REPORTEDVIDEO_UPLOADEDVIDEO_NON_EXISTCONVERTED_FAILEDFAILEDFILES_CONVERTED
vehicle_name
string 
required
Name of device
video_option
enum<string> 
required
Event video upload option set in profile for this type
Allowed values:
alert_onlysnapshot_onlyvideo_snapshot
geotab_user_id
optional
Geotab user ID that requested event
driver_card_id
required
Driver card ID
result
enum<string> 
required
"OK" if request successful, otherwise "Failed"
Allowed values:
OKFailed
Example
{
    "meta": {
        "code": 200
    },
    "response": {
        "accurate_duration": 30,
        "archive": "archived",
        "company_id": 9344,
        "created_by": 8210,
        "createtime": "Fri, 06 Jun 2025 12:17:48 GMT",
        "custom_event_type": "My Custom Event",
        "device_id": "5779963032",
        "driver_name": "Dr. Yolanda Herzog",
        "driver_email": "Wyatt92@hotmail.com",
        "driver_id": "0584A766",
        "duration": 5,
        "end_ts": "Thu, 05 Jun 2025 20:45:38 GMT",
        "event_label": "nostrud i",
        "event_type": "Seatbelt",
        "event_display_type": "My Custom Event",
        "flagged": true,
        "feedback": null,
        "groups": [
            "Group A",
            "Group A",
            "Group A"
        ],
        "geotab_driver": "Bethany Pollich",
        "has_review": false,
        "id": 746008821,
        "impact_score": true,
        "last_reviewed": "2024-01-01 00:00:00",
        "last_reviewed_by": 9,
        "last_viewed": {
            "viewed_ts": "2024-01-01 12:31:42",
            "viewer": {
                "first_name": "Daren",
                "last_name": "Greenfelder"
            }
        },
        "meta_json": 0,
        "mp4_1": 0,
        "mp4_2": true,
        "mp4_3": null,
        "mp4_4": null,
        "nvr_filename": "laborum in commodo sint",
        "old_device_id": 59911304,
        "request_ts": "2024-01-01 12:31:42",
        "restored_user_id": "qui",
        "restoring_start_ts": "2024-01-01 12:31:42",
        "rule": null,
        "size": -88872730.42133193,
        "snapshots": {
            "1": null,
            "2": [
                {
                    "image_src": "https://rosco.roscocloud.com/rosco-user-3233/2509618444/866131810/2.jpg?AWSAccessKeyId=MOlT47hZpVliesgyvRchQm&Signature=AjT7ZjdQM1Nnl1glW6TK7F&Expires=20251030043851",
                    "timestamp": "2025-06-06 07:55:54"
                },
                {
                    "image_src": "https://rosco.roscocloud.com/rosco-user-3233/2712685726/212055067/2.jpg?AWSAccessKeyId=AdfH0xT6Tq2AZSzRDeaEEm&Signature=VNASCo2AoKld1k3LGVIeQb&Expires=20260508040541",
                    "timestamp": "2025-06-06 10:32:43"
                },
                {
                    "image_src": "https://rosco.roscocloud.com/rosco-user-3233/9248116778/192757672/2.jpg?AWSAccessKeyId=Plu6xSHm5FcHJn6S8DRv6u&Signature=5jU12ipFeULiRusZn0a3JB&Expires=20251107131934",
                    "timestamp": "2025-06-06 12:11:17"
                }
            ],
            "3": [
                {
                    "image_src": "https://rosco.roscocloud.com/rosco-user-3233/3583257282/197174520/3.jpg?AWSAccessKeyId=0oYE5Y3My51eNvrEq6d2wI&Signature=tfSCF6LWfl0aVcCgfxib9Q&Expires=20250918012425",
                    "timestamp": "2025-06-05 17:48:17"
                },
                {
                    "image_src": "https://rosco.roscocloud.com/rosco-user-3233/2721592461/885564316/3.jpg?AWSAccessKeyId=rMsSPs0e7kABrasXlCqm2j&Signature=P4Uhqt2mYvNupje7Acqja0&Expires=20260319123558",
                    "timestamp": "2025-06-05 19:09:43"
                },
                {
                    "image_src": "https://rosco.roscocloud.com/rosco-user-3233/3687813185/172702183/3.jpg?AWSAccessKeyId=4rGWSjQtqY8LEOYc7wrn0R&Signature=8AgaBt1Sqrbm7cJeJ924WK&Expires=20260228052918",
                    "timestamp": "2025-06-06 05:12:10"
                }
            ]
        },
        "snapshot_status": "labore",
        "start_ts": "2025-06-06 08:22:54",
        "status": "Duis exercitation",
        "timestamp": "2025-06-06 00:58:47",
        "type": "Seatbelt",
        "uploaded_timestamp": null,
        "uploading_status": "CONVERTED_FAILED",
        "vehicle_name": "Truck 1",
        "video_option": "video_snapshot",
        "geotab_user_id": null,
        "driver_card_id": null
    },
    "result": "OK"
}
🟠401Login Required
Modified at 2025-07-17 17:06:43
Previous
get dates of events of a device
Next
delete an event
Built with