Cumulocity

Cumulocity Bayeux Handshake API

The Bayeux Handshake API from Cumulocity — 1 operation(s) for bayeux handshake.

Documentation GitHub OpenAPI

Operations 1

POST /notification/realtime Bayeux Channel Endpoint (Handshake, Connect, Subscribe, Disconnect) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cumulocity-bayeux-handshake-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Cumulocity Real-Time Notifications Bayeux Handshake API
  version: 10.20.0
  description: 'Bayeux/CometD-based long-poll subscription protocol for receiving live updates of measurements, events,

    alarms, operations, and inventory changes. Predates Notification 2.0 but remains the default for the Web

    SDK and legacy integrations.

    '
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Bayeux Handshake
paths:
  /notification/realtime:
    post:
      tags:
      - Bayeux Handshake
      summary: Bayeux Channel Endpoint (Handshake, Connect, Subscribe, Disconnect)
      operationId: bayeuxChannelEndpoint
      description: 'Single endpoint for the Bayeux/CometD protocol. The channel of the message body determines the

        action — `/meta/handshake`, `/meta/connect`, `/meta/subscribe`, `/meta/unsubscribe`,

        `/meta/disconnect`. Subscribe to channels such as `/measurements/{deviceId}`,

        `/events/{deviceId}`, `/alarms/{deviceId}`, `/operations/{deviceId}`, `/managedobjects/{deviceId}`.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BayeuxMessage'
      responses:
        '200':
          description: Bayeux protocol response.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BayeuxMessage'
components:
  schemas:
    BayeuxMessage:
      type: object
      required:
      - channel
      properties:
        channel:
          type: string
        clientId:
          type: string
        id:
          type: string
        data: {}
        successful:
          type: boolean
        subscription:
          type: string
        ext:
          type: object
        advice:
          type: object
        supportedConnectionTypes:
          type: array
          items:
            type: string
        connectionType:
          type: string
        version:
          type: string
        minimumVersion:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Cumulocity Bayeux Handshake API

Operations 1

Documentation

Specifications

Schemas & Data

Other Resources