Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Client Connection Considerations
PushTopic Events
Working with PushTopics
PushTopic Queries
Security and the PushTopic Query
Supported PushTopic Queries
Compound Fields in PushTopic Queries
Unsupported PushTopic Queries
Event Notification Rules
Replay PushTopic Streaming Events
Filtered Subscriptions
Bulk Subscriptions
Deactivating a Push Topic
PushTopic Considerations
PushTopic Streaming Allocations
Reference: PushTopic
Generic Events
Monitoring Event Usage
PDF

Newer Version Available

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

Supported PushTopic Queries

All custom objects are supported in PushTopic queries. A subset of standard objects is supported in PushTopic queries, including:
  • Account
  • Campaign
  • Case
  • Contact
  • ContractLineItem
  • Entitlement
  • Lead
  • LiveChatTranscript
  • MessagingSession
  • Opportunity
  • Quote
  • QuoteLineItem
  • ServiceAppointment
  • ServiceContract
  • Task
  • UserServicePresence
  • WorkOrder
  • WorkOrderLineItem

Not all objects may be available in your org. Some objects require specific feature settings and permissions to be enabled.

Tasks that are created or updated using the following methods don’t appear in task object topics in the streaming API.

  • Lead conversion
  • Entity merge
  • Mass email contacts/leads

Important

Also, the standard SOQL operators as well as most SOQL statements and expressions are supported. Some SOQL statements aren’t supported. See Unsupported PushTopic Queries.

The following are examples of supported SOQL statements.
  • Custom object
    1SELECT Id, MyCustomField__c FROM MyCustomObject__c
  • Standard objects (can include custom fields)
    • Account
      1SELECT Id, Name FROM Account WHERE NumberOfEmployees > 1000
    • Campaign
      1SELECT Id, Name FROM Campaign WHERE Status = 'Planned'
    • Case
      1SELECT Id, Subject FROM Case WHERE Status = 'Working' AND IsEscalated = TRUE
    • Contact
      1SELECT Id, Name, Email FROM Contact;
    • Lead
      1SELECT Id, Company FROM Lead WHERE Industry = 'Computer Services'
    • Opportunity
      1SELECT Id, Name, Amount FROM Opportunity WHERE CloseDate < 2011-06-14
    • Task
      1SELECT Id, Subject, IsClosed, Status FROM Task WHERE isClosed = TRUE

      In general, changes in fields that the system populates, such as LastModifiedDate and LastActivityDate, don’t trigger notifications. In addition, see these field considerations for Task records.

      • To receive notifications on the IsClosed field, the subscriber must subscribe to the Status field referenced in the query.
      • To receive notifications on the WhoCount and WhatCount fields, the subscriber must subscribe to the WhoId and WhatId fields. Subscriptions based only on the WhoCount or WhatCount fields aren’t supported.
      • To receive notifications for task record deletions, the subscribed user must have the View All Data or the Modify All Data permission when the organization-wide sharing setting for activities is private.

      Important