Add Webhook Subscription to Multiple Event Types

Provide a URL for a call-back server to listen and receive webhook notifications sent by RoscoLive for the notification types(type_ids) subscribed to for the passed in company_id. More than one URL can be subscribed to the same notification types for the same company. Use the Delete Webhook Subscription endpoint to remove a webhook subscription from the company if it is no longer required.

Type	Type ID
Events and Alerts	0
Alerts	1
Events	2
Device Status (Connection Status)	3
Ignition State	4
Input Sensor	5
Unidentified Driver	6
Identified Driver	7
Channel Status (Bad Channel)	8

Request

Path Params

company_id

integer

required

Unique ID for company record

Example:

1234

Body Params multipart/form-data

subscribe_url

string <url>

required

URL address for the call-back server where notifications will be sent

Example:

https://prod-example-39.webhook.cool

type_ids

enum<string>

required

String of comma-separated values that represent webhook notifications to subscribe to from the available list of notifications. Not allowed empty

Allowed values:

012345678

Examples:

1,25

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by response

response

object

required

Contains response data

webhooks

array[object (Webhook Subscription) {4}]

required

result

string

required

"OK" if successful, else "Failed" if error

Example

{
    "meta": {
        "code": 200
    },
    "response": {
        "webhooks": [
            {
                "created_at": "2025-06-12 15:08:05",
                "id": 822,
                "notifications": 1,
                "url": "https://wh_example.com"
            },
            {
                "created_at": "2025-06-12 15:08:05",
                "id": 823,
                "notifications": 5,
                "url": "https://wh_example.com"
            }
        ]
    },
    "result": "OK"
}

🟠400Bad Request

🟠401Login Required

🟠404Resource Not Found

🔴500Internal Server Error