WebSocket consumer. Connection URL is `wss://{tenant}.cumulocity.com/notification2/consumer/?token={jwt}`. Server pushes notifications as JSON frames; consumer ACKs by message id.
Acknowledge a notification by its message id so the server can advance the per-subscriber cursor.
subscribe
consumeNotifications
Receive notifications for the subscriptions associated with the JWT token.
Messages
ack
Notification Acknowledgement
Content-Type:
managedObjectNotification
Managed Object Notification
Content-Type:
measurementNotification
Measurement Notification
Content-Type:
eventNotification
Event Notification
Content-Type:
alarmNotification
Alarm Notification
Content-Type:
operationNotification
Operation Notification
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.