Read Datafeed

Reads the specified 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.

Backward compatibility breaking notice: Starting in May 2025, the ackId parameter must be either set to an empty string or omitted for the first Datafeed Read call.

Read the specified real time message / event stream ("datafeed").

post

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)

Read the specified datafeed.

The ackId sent as parameter can be empty for the first call. In the response an ackId will be sent back and it can be used for the next call: in this way you acknowledge that you have received the events that came with that ackId; datafeed will remove the events associated with that ackId from your queue

Path parameters

datafeedIdstringrequired

ID of the datafeed

Header parameters

sessionTokenstringrequired

Session authentication token.

keyManagerTokenstringrequired

Key Manager authentication token.

Body

ackIdstringoptional

A unique id for events that can be deleted from a client's. Empty for the first read. If set to null or missing, it will be considered empty feed.

updatePresenceboolean · default: trueoptional

Set to false to avoid updating the user's presence when reading events. Default is true.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'youragentURL.symphony.com/agent/v5/datafeeds/{datafeedId}/read' \
  --header 'sessionToken: text' \
  --header 'keyManagerToken: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "ackId": "text",
    "updatePresence": true
  }'

200

400

401

403

500

200

{
  "events": [
    {
      "id": "text",
      "messageId": "text",
      "timestamp": 1,
      "type": "text",
      "diagnostic": "text",
      "initiator": {
        "user": {
          "userId": 1,
          "firstName": "text",
          "lastName": "text",
          "displayName": "text",
          "email": "text",
          "username": "text"
        }
      },
      "payload": "[Circular Reference]"
    }
  ],
  "ackId": "text"
}

Datafeed successfully read.

ackId: The ackId sent as a parameter must be either set to an empty string or omitted in the first call. In the response, an ackId will be sent back and it must be used for the next call. This way, you acknowledge that you have received the events that came with that ackId and that the datafeed will remove the events associated with that ackId from your queue. Events that have not been acknowledged will be re-queued and distributed again in a successive call.

Datafeed ttl: A datafeed time-to-live (ttl) is 30 minutes which means that, if your code doesn't poll the feed for 30 minutes, the feed will be deleted and your program will not receive queued messages. If your code attempts to read an expired or deleted feed, you will receive a 400 error code. Upon receiving a 400 error code, you need to create a new feed to continue to receive messages. Messages sent between the time the feed is deleted and you re-create a new one, will be lost.