Download the PHP package ae/salesforce-rest-sdk without Composer

Salesforce Rest SDK

This API supports the following areas of the Salesforce API:

• Limits
• Global Describe
• SObject Describe
• SObject CRUD
• SObject Get Updated/Deleted
• Composite API
  • Batch
  • Tree
  • SObject Collections
• Bulk API
• Streaming API

Installation

Instantiate a Rest Client

For more information about using client app names with Change Data Capture, see https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_event_fields_header.htm

If you have an authorization code returned to your redirectUrl and wish to use it, you can do so like this:

Cached Auth Providers

Cached Auth Providers provide a way to hold onto valid credentials across requests, otherwise the client will authenticate with Salesforce every time it's instantiated.

Composer autoloading without a framework

If you happen to not be using a PHP Framework that handles annotation registration for you, like Symfony, then you must do it yourself:

Work with SObjects with the SObject Client

Reference

For more information on Batch Sizes and the Sforce-Query-Options header, see https://developer.salesforce.com/docs/atlas.en-us.220.0.api_rest.meta/api_rest/headers_queryoptions.htm.

It should be noted that batch size may not be respected in Salesforce if it is not optimal for performance

Instantiate the Streaming Client

Reference

Subscribe to a PushTopic

• Reference: Create a PushTopic
• Reference: Supported PushTopic Queries

You can create a new PushTopic using the Rest Client above. The topic only needs created once in a Salesforce Org. All custom objects are supported by the Streaming API, however, not all standard objects supported.

Supported Standard Objects:

• Account
• Campaign
• Case
• Contact
• ContractLineItem
• Entitlement
• Lead
• LiveChatTranscript
• Opportunity
• Quote
• QuoteLineItem
• ServiceContract
• Task

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

The $client->start(); is a blocking call and no code after it will execute until an error occurs in the client, causing it to disconnect.

For instance, the client must reconnect to the streaming server within 40 seconds after each notification is received. If it fails to do so, it will attempt to re-handshake to create a new connection. If that fails, then the client will disconnect, which will allow the rest of the script to execute.

It's recommended that the streaming client be run in it's own thread

Dispatching Generic Events

Create a Streaming Channel

Before you can dispatch a Generic Event, you must create a Streaming Channel. That can be done in a number of ways:

1. Via the Salesforce Classic UI as documented here
2. By enabling Enable Dynamic Streaming Channel Creation under Setup > User Interface and then subscribing to a Streaming Channel using the Streaming Client as documented above
3. Streaming Channels are a regular ole SObject and can be created like one:

Send Generic Events to the Streaming Channel

Once the StreamingChannel is created, events can now be sent to it using the GenericEventClient, which piggybacks on the SObject client. Let's pretend we're continuing the code from above in this next example:

Future Additions

• Tooling API
• Metadata API