Send data to an app using the data stream API

In this how-to guide, you'll learn how to send data to an app using the data stream API.

Requirements

1. You have created a data stream

2. You have linked the data stream to a composition

This guide is language and platform agnostic. Thus, you can follow along using cURL or whatever language you use to make API requests as well as on Postman or the API platform of your choice. To try it out on Postman, visit the Singular Postman collection.

How to send data to an app using the data stream API

1. Prepare a PATCH request to send to https://datastream.singular.live/datastreams/:datastreamPrivateToken, which is the endpoint for the Singular data stream API.

2. Replace :datastreamPrivateToken with the actual private token. (This can be found on the data stream manager, located on the user menu on the Singular Dashboard.)

3. Add a request body that matches the format of, and updates, the payload of the sub-composition that is connected to the data stream in the overlay's composition.

4. With the composition editor in Composer open, send the request and watch the data update.