RoscoLive API v1.0
    RoscoLive API v1.0
    • Authentication
      • Login
        POST
      • Logout
        GET
      • mark eula as viewed
        POST
      • password change
        POST
      • password reset
        POST
    • Company
      • get camera health error
        GET
      • create a company
        PUT
      • get partner settings
        GET
      • get audit logs of a company
        GET
      • get input sensors notifications of a company
        GET
      • get ignition notifications of a company
        GET
      • get a company by ID
        GET
      • update a company by ID
        POST
      • update company
        POST
      • search companies
        GET
      • get companies list
        GET
      • get a company
        GET
      • get companies
        GET
      • get partner companies list
        GET
      • get own partner company
        GET
    • Custom Role Permissions
      • get full list of available custom user permission
        GET
    • Device
      • get company devices
        GET
      • search devices
        GET
      • update a device
        POST
      • get a device data usage
        GET
      • Play in-cab audible alert sound for device
        POST
      • get devices data usage
        GET
      • get a company devices by company ID
        GET
      • restart a device
        GET
      • get company devices with modems
        GET
      • get distance
        GET
      • get installed report of a device
        GET
      • get an installed report
        GET
      • merge profile with device config
        POST
      • get audit logs of a device
        GET
      • get list of trip dates for device
        GET
      • get list of trips for passed device and date
        GET
      • Get a device
        GET
      • get list of company devices
        GET
      • get device with driver id
        GET
      • create devices (legacy/DV4)
        PUT
      • create devices (auto-prov/DV6)
        PUT
      • get company device using IMEI/SN
        GET
      • check red bubble in manage vehicles
        GET
      • bulk device creation
        PUT
      • get devices for all companies available for user
        GET
      • get list of trip related snapshots
        GET
      • reset status of sd card
        POST
      • get list of all available dates
        GET
      • get available video list for date
        GET
      • replace device
        POST
      • get replace history by device id
        GET
      • clear device channel status
        POST
      • get camera health error by device id
        GET
      • get camera health definitions
        GET
      • update camera health error by error id
        POST
      • update camera health errors
        POST
      • Get device list for multiple companies
        GET
      • Get current activity status of devices
        GET
    • 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 a driver
      • 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
      • Get company events
      • get an event
      • send an event
      • get status of an event
      • Request videos of an event
      • get uploaded videos of an event
      • get events summary of devices
      • get events summary of a device
      • get a company events by company ID
      • get status of an event by company ID
      • get snapshots of an event or alert
      • get snapshots of an event or alert by company ID
      • get a last event
      • get a last event of devices
      • get events log of a device
      • get dates of events
      • get events for charts and graphs
      • get events for charts and graphs by company ID
      • get an event by company ID
      • get events summary of a device by company ID
      • request videos of an event by company ID
      • get dates of an events by company ID
      • get a last event of company device
      • clear last event
      • get dates of events of a device
      • push custom event
      • delete an event
      • request videos of an alert
      • share an event
      • get an event by a permalink
      • get geotab events
      • get a last updated event of devices
      • download a blocked event
      • Get flagged company events
      • flag an event
      • unflag an event
      • generate snapshots
      • local geocoding service
      • update an event
      • get snapshot/location of event
      • Get events for a device
      • Request custom video from device
      • get snapshot on demand
      • get an event by a permalink hash
      • Set Event Label for Event
      • Restore event video from archive
      • Add users for notification of event restore from archive
      • Add event label
      • Add user feedback to event
      • Get event user feedback
      • Get event filters list for date range in company
    • 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 a user
      • update a user
      • remove a user
      • Get own info
      • create a user
      • get company 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
      • get push notifications
      • set push notifications
      • remove push notifications

    Webhooks

    RoscoLive Webhook Notifications#

    RoscoLive v1.0 API provides an interface to allow for the subscription and management of call-back server URLs to then receive webhook notifications for the specified company. RoscoLive webhooks send data to the call-back URLs on a live-basis as the data is received and updated on our server in a "fire-and-forget" manner, meaning once data is sent over a webhook there is no replaying that notification response.
    What are Webhooks?
    Webhook notifications (sometimes referred to as "push notifications") are a type of API in which a server on the client end (call-back server) can subscribe to the host server and messages or response data from the host server are sent to the client via a URL the client has provided to the host. Traditionally, REST APIs call or "pull" data from the server by calling an endpoint and waiting to receive the data. The caller must do this each time they want new data which can be an expensive and inefficient operation if this data is required to be polled frequently. Webhook notifications provide a more efficient solution by "pushing" this data to a URL the client has provided which listens for new data from that endpoint.

    Notification Types#

    RoscoLive webhooks send data according to the notification types configured for that webhook subscription. The following are the available notification types that can be set for a webhook subscription.

    Alerts#

    Type ID: 1
    Alerts reported by the camera or device to the server.
    Alerts and Events, although very similar, are not the same. Alerts are when a sensor is triggered on the camera and the resulting data is then reported to RoscoLive servers. Events are alerts that will have media associated with it, such as video and snapshots showing the cause of the alert.
    Alert Notification Object
    keytypedescription
    namestringName of the notification type
    sensor_namestringName of the sensor that generated alert
    sensor_numberintSensor index number
    sensor_statusstringStatus if sensor is "on" or "off"
    sensor_valueintA value that represents data from the sensor. Not all alert sensors report relevant sensor values.
    vehicle_idintAKA device ID. Unique ID associated to this device on RoscoLive.
    List of Possible Sensor Names and Index Numbers
    sensor_namesensor_number
    None0
    CameraBlock3
    VideoLoss4
    PanicButton6
    InputSensor7
    Voltage8
    GSensor9
    GpsError10
    HighSpeed13
    HddError14
    HighTemperature15
    FatalGSensor16
    MotionDetect22
    TireEvent23
    UncleanShutdown24
    PedestrianWarning25
    LaneDeparture26
    ForwardCollisionWarning27
    HeadwayWarning28
    DmsWarning29
    HarshAccel30
    HarshBraking31
    FollowingDistanceWarning32
    Driver33
    ExternalDriver34
    SdCardRemoval35
    UnknownDriver36
    LSA37
    MSA38
    HSA39
    SSA40
    example response

    Events#

    Connection Status#

    Ignition State#

    Input Sensor#

    Unidentified Driver#

    Identified Driver#

    Modified at 2024-09-27 00:32:20
    Previous
    Get event / sms notification settings
    Next
    get push notifications
    Built with