How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Service Cloud Streaming API

Real-time streaming API for push notifications and event-driven architecture.

This event API exposes 3 operations across 3 channels, and defines 6 schemas. It is described by AsyncAPI 2.6.0, at version 59.0.

The API connects through a single server, https://{instance}.salesforce.com/cometd/59.0 (https).

3 operations 3 channels 6 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
59.0
Base URL
https://yourInstance.salesforce.com/cometd/59.0/
Resource Areas
1

Channels & Operations 3

Across 3 channels, the API surfaces 3 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 3
SUB
/topic/{pushTopicName}
Receive PushTopic notifications
receivePushTopicEvent 1 param body
SUB
/event/{platformEventName}__e
Receive Platform Event notifications
receivePlatformEvent 1 param body
SUB
/data/CaseChangeEvent
Receive Case change events
receiveCaseChangeEvent body

Messages & Schemas 6

The contract defines 6 schemas that model the data carried by its messages. The most detailed are ChangeEventPayload (2 properties), PlatformEventPayload (2 properties), PushTopicPayload (2 properties). Each schema is shown below with its type and property counts.

PushTopicEvent
message
Notification triggered when an sObject record matching the PushTopic SOQL query is created, updated, deleted, or undeleted.
PlatformEvent
message
Custom event message published through the Salesforce Platform Events framework.
ChangeDataCaptureEvent
message
Event containing field-level change details for a modified sObject record.
PushTopicPayload
object
2 properties
PlatformEventPayload
object
2 properties
ChangeEventPayload
object
2 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

salesforce-streaming-api-asyncapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Service Cloud Streaming API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.