AsyncAPI channel · Salesforce
· Salesforce Platform Events API
/event/{platformEventApiName}
CometD channel for subscribing to a Platform Event type. Receives events published to this event type from Apex triggers, flows, REST API calls, or external systems via the REST API.
platformEventApiName — The API name of the Platform Event object including the __e suffix (e.g., Order_Event__e, Low_Ink__e)
Operations
publish
publishPlatformEvent
Publish a Platform Event via CometD (internal use)
subscribe
receivePlatformEvent
Receive a Platform Event notification
Messages
PlatformEventPublish
Payload structure for publishing a Platform Event via REST API
Content-Type: application/json
PlatformEventMessage
A Platform Event notification received via CometD
Content-Type: application/json
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.
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.