Streaming API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Getting Started with Streaming API
Code Examples
Client Connection Considerations
PushTopic Events (Legacy)
Generic Events (Legacy)
Replay Generic Streaming Events with Durable Generic Streaming
Generic Streaming Quick Start
Create a Streaming Channel
Run a Java Client with Username and Password Login
Run a Java Client with OAuth Bearer Token Login
Generate Events Using REST
Generic Streaming Allocations
Reference: StreamingChannel
Reference: Streaming Channel Push REST API
Monitoring Event Usage
PDF

Generate Events Using REST

Use the Streaming Channel Push REST API resource to generate event notifications to channel subscribers.

Prerequisites:

You use Postman to perform these steps. Before you begin, set up Postman by completing Quick Start: Connect Postman to Salesforce in Trailhead.

  1. After setting up Postman and authenticating, get the streaming channel ID by performing a SOQL query using Tooling API.
    1. In Postman, expand REST, and click Query.
    2. Click Params, then for the q value, enter this query. 
      SELECT Name, ID FROM StreamingChannel
    3. Click Send.
    4. The response contains the StreamingChannel ID for /u/notifications/ExampleUserChannel. Note this ID for the next step.
  2. Publish an event message using the push REST API resource.
    1. In Postman, expand REST | SObject, and click SObject Create.
    2. Select POST, and append this path to the request URL after replacing <Streaming Channel ID> with the ID you copied earlier: /<Streaming Channel ID>/push.
      The full URL becomes:
      {{_endpoint}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/<Streaming Channel ID>/push
    3. Click Params, then under Path Variables, enter StreamingChannel for SOBJECT_API_NAME.
    4. Click Body, and enter this body value. 
      { 
  "pushEvents": [
  {
    "payload": "Broadcast message to all subscribers", 
    "userIds": [] 
  }
  ]
}
    5. Click Send.
      The request sends the event to all subscribers on the channel. You receive the notification with the payload text in your Java client. The REST method response indicates the number of subscribers the event was sent to (in this case, –1, because the event was set to broadcast to all subscribers).
This example shows the notification message received.
{
  "clientId":"a1ps4wpe52qytvcvbsko09tapc",
  "data":{
    "event":{
      "createdDate":"2016-03-29T19:05:28.334Z",
      "replayId":55
    },
    "payload":"Broadcast message to all subscribers"
  },
  "channel":"/u/notifications/ExampleUserChannel"
}
You’ve successfully sent a notification to a subscriber using generic streaming. You can specify the list of subscribed users to send notifications to instead of broadcasting to all subscribers. Also, you can use the GET method of the Streaming Channel Push REST API resource to get a list of active subscribers to the channel.