Subscribe to real-time delivery change events.

GET 
/api/v2/events/delivery

Opens an SSE stream that fires whenever a delivery state changes. The payload is the native Delivery record — requiring no follow-up HTTP fetch by the consumer. Consumers should filter events by catalog_id to handle multiple concurrent deliveries.

Request

Responses

200

SSE stream — fires Delivery on every delivery state change

text/event-stream

Schema

Schema

artifacts

object[]

required

Array [

arguments stringnullable

artifactType stringnullable

catalogId stringrequired

downloadDuration int32nullable

downloadEta int32nullable

downloadId int32nullable

hash

object

nullable

required

algorithm stringrequired

hash stringrequired

isExecutable booleannullable

itemKey stringrequired

metaData stringnullable

path stringnullable

progress floatrequired

signature stringnullable

size int64required

status DeliveryStatusEnumrequired

Possible values: [Start, InProgress, Done, Pause, Cancel, Error, Queued, Registered]

url stringrequired

]

catalogId stringrequired
deviceId stringnullable

Reporting device id when this delivery reflects a remote (child) device's status; None for a local delivery (implicitly this device).

dir stringnullable
downloadDone date-timenullable

error

object

nullable

errorCode stringnullable

message stringnullable
itemType ItemTyperequired

Possible values: [software, map, cache, config]

progress floatrequired
queuedAt date-timenullable
state DeliveryStaterequired

Possible values: [prepare, download, validation, done]

status DeliveryStatusEnumrequired

Possible values: [Start, InProgress, Done, Pause, Cancel, Error, Queued, Registered]

Example (from schema)

{
  "artifacts": [
    {
      "arguments": "string",
      "artifactType": "string",
      "catalogId": "string",
      "downloadDuration": 0,
      "downloadEta": 0,
      "downloadId": 0,
      "hash": {
        "algorithm": "string",
        "hash": "string"
      },
      "isExecutable": true,
      "itemKey": "string",
      "metaData": "string",
      "path": "string",
      "progress": 0,
      "signature": "string",
      "size": 0,
      "status": "Start",
      "url": "string"
    }
  ],
  "catalogId": "string",
  "deviceId": "string",
  "dir": "string",
  "downloadDone": "2026-11-08T13:48:42.674Z",
  "error": {
    "errorCode": "string",
    "message": "string"
  },
  "itemType": "software",
  "progress": 0,
  "queuedAt": "2026-11-08T13:48:42.675Z",
  "state": "prepare",
  "status": "Start"
}

Loading...