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.

Number of active feeds

In the vast majority of the use cases, your bot should have only one active feed.

The platform however supports up to 20 feeds per service user. If you try to create a 21st feed, you will receive a 403 error code. In that case you need to delete one of your active feeds (i.e. get the list of feeds using List Datafeed, then Delete Datafeed on one of the listed feeds).

Create a new real time feed of messages and events.

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)

Returns the ID of the newly created datafeed. This ID should then be used as input to the Read Datafeed endpoint.

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringOptional

Key Manager authentication token.

Body

application/json

tagstring · max: 100Optional

A unique identifier to ensure uniqueness of the datafeed.

includeInvisiblebooleanOptional

Set to true to retrieve invisible rooms related events. Default is false.

Responses

201

Datafeed sucessfully created.

application/json

Container for the feed ID

idstringOptional

ID of the datafeed

createdAtinteger · int64OptionalDeprecated

[deprecated] Datafeed creation timestamp

typestringOptional

The type of feed. Only allowed value is "datahose".

400

Bad request.

application/json

401

Unauthorized.

application/json

500

Internal server error.

application/json

post/v5/datafeeds

HTTPcURLJavaScriptPython

POST /agent/v5/datafeeds HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "tag": "text",
  "includeInvisible": true
}

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