Stream entity events

Beta
Establishes a persistent connection to stream entity events as they occur.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
heartbeatIntervalMSintegerOptional
at what interval to send heartbeat events, defaults to 30s.
preExistingOnlybooleanOptional

only stream pre-existing entities in the environment and then close the connection, defaults to false.

componentsToIncludelist of stringsOptional
list of components to include, leave empty to include all components.

Response

Returns all pre-existing data and then return all new data as they become available.

heartbeatobject
OR
entityobject

Errors