RoscoLive API v1.0(v2.41.0)
    • Authentication
      • Login
        POST
      • Logout
        GET
    • Report
      • Get custom report data
        GET
      • Get paired GO device report
        GET
      • Update custom report
        POST
      • Create custom report for user
        PUT
    • Company
      • private
        • Create a new partner company
        • Update partner company info
        • Get a partner company
        • Disable a customer company
        • Enable a customer company
        • Disable a partner company
        • Enable a partner company
      • Create a company
        PUT
      • Get a company by ID
        GET
      • Update company
        POST
      • Get a company
        GET
      • Get companies
        GET
      • Get own partner company
        GET
    • Remote Device Management
      • Get device config history
        GET
      • Get device config history file
        GET
    • Device
      • Search devices
        GET
      • Update a device settings
        POST
      • Get a device
        GET
      • Get list of company devices
        GET
      • Get device with driver ID
        GET
      • Create devices (auto-prov/DV4/DV6/DV7)
        PUT
      • Get devices for all companies available for user
        GET
      • Get device list for multiple companies
        GET
      • Get current activity status of devices
        GET
    • Driver Scoring / Coaching
      • Get company event score weights
      • Update company event score weights
    • Event
      • Get Company Events
      • Get Latest Event for Each Device in Company
      • Share an event
      • Get a last updated event of devices
      • Get list of company events
    • External Service
      • BeWhere
        • Get BeWhere trackers by group
        • Add BeWhere tracker to group
        • Remove BeWhere tracker from group
        • Get list of BeWhere trackers for a company
        • Get available dates for a BeWhere tracker
        • Get metadata for a BeWhere tracker
    • Group
      • Get devices of a group
    • Metadata
      • Get alerts and events of devices for company
      • Get alerts of a device
    • 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
    • Installer App
      • Get user installed devices

    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 alerts of a device
    Next
    Add Webhook Subscription to Multiple Event Types
    Built with