Subscription
HTTP API schema
← HTTP API referenceView source specification ↗
A subscription is a way to listen to events
Subscription fields
- id
stringRequired The unique identifier for the subscription
- owner
string The owner of the subscription
- targetMessageTargetRequired
target: Reference MessageTarget
- context
object 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.
- status
string Event monitor lifecycle.
Allowed values: ACTIVE, PAUSED, SUSPENDED, EXPIRED, STOPPED.
- reasonCode
string Redacted stable lifecycle reason, when applicable.
- expiresAt
string Finite expiration; null means indefinite.
format: "date-time"
nullable: true
- eventQueryProfile
string Supported typed event query validation profile, when this is an event monitor.