Developer Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

User Event Stream

The User Event Stream is designed to receive all possible events that are associated with your user. This includes any call notification and progress events, text messages that you send and receive, events for conversation management in your communicator, periodic unread counts, settings or preferences updates, and everything else that has a matching user id attached to the event.

Events

{"type":"startusereventrequest"}
{"type":"startusereventresponse", "success":true}


{"type":"stopusereventrequest"}
{"type":"stopusereventresponse", "success":true}


All events on the stream will have {"type":"userevent"} and will contain various other data properties, depending on the event.

{"type":"userevent", ...}