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

Salesforce Platform Events API

Salesforce Platform Events enables event-driven integration architectures built on the Salesforce platform. Developers define custom event types as Salesforce objects and publish or subscribe to events using the REST API, Apex, or Salesforce Flows.

Salesforce Platform Events API is one of 294 APIs that Salesforce publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include CRM, Event-Driven, Event, Integration, and Platform Events. The published artifact set on APIs.io includes API documentation, a getting-started guide, an API reference, and an AsyncAPI specification.

This event API exposes 2 operations across 1 channel, and defines 5 schemas. It is described by AsyncAPI 2.6.0, at version 59.0.

The API connects through 2 servers: https://{instanceName}.salesforce.com/cometd/{apiVersion} (https), api.pubsub.salesforce.com:443 (grpc).

2 operations 1 channels 5 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
59.0
Base URL
https://{instance}.salesforce.com/services/data/v{version}/sobjects
Resource Areas
1

Channels & Operations 2

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

Channels 2
SUB
/event/{platformEventApiName}
Receive a Platform Event notification
receivePlatformEvent 1 param body
PUB
/event/{platformEventApiName}
Publish a Platform Event via CometD (internal use)
publishPlatformEvent 1 param body

Messages & Schemas 5

The contract defines 5 schemas that model the data carried by its messages. The most detailed are PlatformEventData (3 properties), PlatformEventPublishPayload (2 properties), PlatformEventEnvelope (2 properties). Each schema is shown below with its type and property counts.

PlatformEventMessage
message
A Platform Event notification received via CometD
PlatformEventPublishMessage
message
Payload structure for publishing a Platform Event via REST API
PlatformEventEnvelope
object
The CometD envelope wrapping a received Platform Event
2 properties
PlatformEventData
object
Event metadata
3 properties
PlatformEventPublishPayload
object
Payload for publishing a Platform Event via POST to /services/data/v{version}/sobjects/{EventApiNamee}
2 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

salesforce-platform-events-asyncapi.yml Raw ↑

Other APIs Salesforce publishes across the network.

Salesforce REST API
Salesforce SOAP API
Salesforce Bulk API
Salesforce Streaming API
Salesforce Metadata API
Salesforce Tooling API
Salesforce Connect API (Chatter)
Salesforce Analytics REST API
Salesforce Reports and Dashboards REST API
Salesforce Einstein Platform Services API
Salesforce Einstein Prediction Service API
Salesforce GraphQL API
Where this information came from

This is an independent, third-party profile of Salesforce Platform Events 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.