Salesforce · AsyncAPI Specification

Salesforce Platform Events API

Version 59.0

Salesforce Platform Events enables event-driven integration architectures on the Salesforce platform. Developers define custom event types as Salesforce objects with the __e suffix and publish or subscribe to events using the REST API, Apex triggers, or CometD subscriptions. Events are durable and stored for 72 hours, supporting replay for missed events.

View Spec View on GitHub AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSalesAsyncAPIWebhooksEvents

Channels

/event/{platformEventApiName}

publish publishPlatformEvent

Publish a Platform Event via CometD (internal use)

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.

Messages

✉

PlatformEventMessage

Salesforce Platform Event

A Platform Event notification received via CometD

✉

PlatformEventPublishMessage

Platform Event Publish Payload

Payload structure for publishing a Platform Event via REST API

Servers

https

salesforce-cometd https://{instanceName}.salesforce.com/cometd/{apiVersion}

CometD endpoint for subscribing to Platform Events

grpc

salesforce-pubsub api.pubsub.salesforce.com:443

Pub/Sub API gRPC endpoint (recommended for high-throughput subscriptions)