PushTopic | Object Reference for Salesforce and Force.com

Supported Calls

REST: DELETE, GET, PATCH, POST (query requests are specified in the URI)

SOAP: create(), delete(), describe(), describeSObjects(), query(), retrieve(), update()

Special Access Rules

This object is only available if Streaming API is enabled for your organization.
Only users with “Create” permission can create this record.

Fields

Field	Field Type	Description
ApiVersion	double	Required. API version to use for executing the query specified in Query. It must be an API version greater than 20.0. If your query applies to a custom object from a package, this value must match the package's ApiVersion. Example value: 41.0 Field Properties: Create, Filter, Sort, Update
Description	string	Description of the PushTopic. Limit: 400 characters Field Properties: Create, Filter, Sort, Update
ID	ID	System field: Globally unique string that identifies a record. Field Properties: Default on create, Filter, Group, idLookup, Sort
isActive	boolean	Indicates whether the record currently counts towards the organization's limit. Field Properties: Create, Default on create, Filter, Group, Sort, Update
IsDeleted	boolean	System field: Indicates whether the record has been moved to the Recycle Bin (`true`) or not (`false`). Field Properties: Default on create, Filter, Group, Sort
Name	string	Required. Descriptive name of the PushTopic, such as `MyNewCases` or `TeamUpdatedContacts`. Limit: 25 characters. This value identifies the channel and must be unique. Field Properties: Create, Filter, Group, Sort, Update
NotifyForFields	picklist	Specifies which fields are evaluated to generate a notification. Valid values: `All` `Referenced` (default) `Select` `Where` Field Properties: Create, Filter, Sort, Update
NotifyForOperations	picklist	Specifies which record events may generate a notification. Valid values: `All` (default) `Create` `Extended` `Update` Field Properties for API version 28.0 and earlier: Create, Filter, Sort, Update Field Properties for API version 29.0 and later: Filter, Sort In API version 29.0 and later, this field is read-only, and will not contain information about delete and undelete events. Use NotifyForOperationCreate, NotifyForOperationDelete, NotifyForOperationUndelete and NotifyForOperationUpdate to specify which record events should generate a notification. A value of `Extended` means that neither create or update operations are set to generate events.
NotifyForOperationCreate	boolean	`true` if a create operation should generate a notification, otherwise, `false`. Defaults to `true`. This field is available in API version 29.0 and later.
NotifyForOperationDelete	boolean	`true` if a delete operation should generate a notification, otherwise, `false`. Defaults to `true`. Clients must connect using the cometd/29.0 (or later) Streaming API endpoint to receive delete and undelete event notifications. This field is available in API version 29.0 and later.
NotifyForOperationUndelete	boolean	`true` if an undelete operation should generate a notification, otherwise, `false`. Defaults to `true`. Clients must connect using the cometd/29.0 (or later) Streaming API endpoint to receive delete and undelete event notifications. This field is available in API version 29.0 and later.
NotifyForOperationUpdate	boolean	`true` if an update operation should generate a notification, otherwise, `false`. Defaults to `true`. This field is available in API version 29.0 and later.
Query	string	Required. The SOQL query statement that determines which record changes trigger events to be sent to the channel. Limit: 1,300 characters Field Properties: Create, Filter, Sort, Update

PushTopic and Notifications

The PushTopic defines when notifications are generated in the channel. This is specified by configuring the following PushTopic fields:

PushTopic Queries
Events
Notifications