Streaming API Developer Guide

Getting Started with Streaming API
Streaming API
Push Technology
Bayeux Protocol, CometD, and Long Polling
Streaming API Terms
How the Client Connects
Message Reliability
Message Durability
Streaming Event Features
Code Examples
Client Connection Considerations
PushTopic Events
Generic Events
Monitoring Event Usage
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Streaming Event Features

The Lightning Platform offers several types of streaming events. To determine which event meets your use case, compare the features of the various events.
Feature PushTopic Event Change Data Capture Event Platform Event Generic Event
Define a custom schema as strongly typed fields N/A N/A Yes No
Include user-defined payloads N/A N/A Yes Yes
Publish custom events via one or more APIs N/A N/A Yes Yes
Publish events via Apex N/A N/A Yes No
Publish declaratively using Process Builder and Flow Builder N/A N/A Yes No
Publish to specific users N/A N/A No Yes
Subscribe via CometD using JavaScript, Java, and other languages Yes Yes Yes Yes
Subscribe via Apex triggers No Yes Yes No
Filter subscriptions Yes No No No
Receive auto-published event notifications for Salesforce record changes Yes Yes N/A N/A
Choose the fields to include in event notifications for Salesforce record changes Yes No N/A N/A
Receive a versioned event schema No Yes Yes No
Get field-level security Yes Yes No No
Get record-sharing support Yes No N/A N/A
Encrypt field data with Shield Platform Encryption No Yes No No
Replay retained event notifications Yes Yes Yes Yes
Event retention period 1 day 3 days 1 day or 3 days* 1 day

* High-volume platform events are retained for up to 3 days.