Datahose - Read Events

Available as beta on Agent 22.6, as GA on Agent 22.7 and above.
Please note there is also a dependency on Datafeed 2.0

Creates and reads real time messages / events streams. As mentioned in Datahose - Read Events, it is based on Datafeed 2.0. The datahose API provides messages and events from all conversations in the pod, even the ones the service user is not part of.

The types of events surfaced can be found in the Real Time Events list.

Using ackId

The Datahose - Read Events endpoint returns the Real Time Events happening in the pod, either since the time the datahose feed was created or since the previous feed was read by the bot. The ackId has an essential role in retrieving the right events for the bot.

The ackId should indeed be null or empty for the first call. Then, for subsequent requests, the ackId from the previous payload should be reused to confirm the reading of previous events already retrieved by the bot.
Please note that you can very easily access this API via our BDKs in Java and Python.

If a batch of messages is not confirmed by sending the ackId, the messages that are there will be returned in the subsequent readings and may blend into the newer messages.

🚧

Required Entitlements

The service account user needs to have both the Can read from datahose feeds and Can create datahose feeds entitlements enabled to call this endpoint.

Language