Create Datafeed

Creates a new real time messages / events stream ("datafeed"). The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list.

Returns the ID of the datafeed that has just been created. This ID should then be used as input to the Read Datafeed endpoint.

Create a new real time messages / events stream ("datafeed").

Available on Agent 2.57.0 and above.

The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file)

Returns the ID of the datafeed that has just been created. This ID should then be used as input to the Read Messages/Events Stream v4 endpoint.

POSTyouragentURL.symphony.com/agent/v5/datafeeds

Header parameters

Body

application/json

tagstring

A unique identifier to ensure uniqueness of the datafeed.

Response

201400401500

Datafeed sucessfully created.

Body

application/json

idstring

ID of the datafeed

typestring

type of the feed. Known values are "fanout" and "datahose"

Request

JavaScriptCurlPython

const response = await fetch('youragentURL.symphony.com/agent/v5/datafeeds', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "keyManagerToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401500

{
  "id": "371f465fb97b5d1027d20a5e7085863a_f",
  "type": "fanout"
}