Skip to content

Subscription

HTTP API schema

← HTTP API reference

A subscription is a way to listen to events

Subscription fields

idstringRequired

The unique identifier for the subscription

ownerstring

The owner of the subscription

nameTypeValue

name: Reference TypeValue

queryQueryRequired

query: Reference Query

targetMessageTargetRequired

target: Reference MessageTarget

contextobject

Structured filter criteria for granular device event matching. Keys are dot-notation paths into the message (e.g., "header.namespace", "header.name"). Values are the expected values to match. All context entries must match for the subscription to fire. Omitting context matches all events.

statusstring

Event monitor lifecycle.

Allowed values: ACTIVE, PAUSED, SUSPENDED, EXPIRED, STOPPED.

reasonCodestring

Redacted stable lifecycle reason, when applicable.

expiresAtstring

Finite expiration; null means indefinite.

format: "date-time"

nullable: true

eventQueryProfilestring

Supported typed event query validation profile, when this is an event monitor.

View source specification ↗