Skip to main content
WEBHOOK
hos_event.added
{
  "version": "<string>",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fleet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fleet_ref": "<string>",
      "source_name": "ada",
      "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "occurred_at": "2023-11-07T05:31:56Z",
      "tsp_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tsp_slug": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "extras": {},
      "driver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vehicle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "co_driver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "additional_driver_ids": {},
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "driver_last_edit_at": "2023-11-07T05:31:56Z",
      "driver_certified_at": "2023-11-07T05:31:56Z",
      "hos_ruleset_code": "US_INT_PROP_60_7",
      "time_zone_code": "UTC",
      "notes": "<string>",
      "duty_status_code": "OFF",
      "event_type_code": "1",
      "event_code": "OFF",
      "log_state_code": "ACTIVE",
      "log_origin_code": "AUTO",
      "deferral_status": "<string>",
      "deferral_minutes": 123,
      "eld_malfunction_code": "POWER",
      "is_excluded": true,
      "is_transitioning": false,
      "record_status": "active",
      "region_code": "US-AL",
      "location_name": "<string>",
      "location": {
        "type": "<string>",
        "coordinates": {
          "[0]": 123,
          "[1]": 123
        },
        "bbox": {
          "[0]": 123,
          "[1]": 123,
          "[2]": 123,
          "[3]": 123
        }
      },
      "h3_index_11": "<unknown>",
      "odometer": 123,
      "engine_hours": 123,
      "sequence": "<string>",
      "version": "<string>"
    }
  ],
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_name": "hos_event.added",
  "timestamp": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "delivery_attempt": 0
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Hos event added event.

version
string
required

Version of the schema used for this event

Pattern: ^\d+\.\d+$
Examples:

"1.0"

"1.1"

"2.0"

data
BaseHosEvent · object[]
required

The event payload, with one or more records of the specified type

webhook_id
string<uuid>
required

Unique identifier for the webhook subscription that triggered this delivery

event_name
string
default:hos_event.added
timestamp
string<date-time> | null

ISO 8601 timestamp when the event occurred

id
string<uuid> | null

Unique identifier for this specific event instance (UUID v7 for time-ordered sorting)

delivery_attempt
integer
default:0

The number of times the event has been attempted to be delivered

Response

Successful Response