This guide outlines how to integrate livestream metadata with our system. You can either send updates via a webhook or use our Now Playing API to automatically ingest data.
Method 1: Sending Updates via Webhook
To update livestream metadata using our webhook, follow these steps:
Add the Livestream:
First, add your live stream in our dashboard.
Once added, locate the live stream ID from the list. For example, the live stream ID is
1060.
Send Metadata Updates:
Make a PUT or PATCH request to the following URL:
https://production.brandsarelive.com/api/webhooks/live-stream-meta/<id>/Replace
<id>with your livestream ID. For example:
https://production.brandsarelive.com/api/webhooks/live-stream-meta/1060/Provide Metadata in JSON Format:
For GROW model:
{
"current_title": "my title",
"current_artist_name": "my artist",
"current_cover_image_url": "https://bar.foo/test.jpg"
}For PRO model (when syncing your music database to AWS):
{
"current_title": "my title",
"current_artist_name": "my artist",
"reference_id": "12345"
}Here,
reference_idis your internal ID of the audio track in your music database. This allows us to map the track and cover image to our database.
Method 2: Integrating with a Now Playing API
If you already have a working Now Playing JSON API, follow these steps:
Provide API URLs:
Share the URLs for all your stations with us.
We will automatically ingest the data from these APIs.
Important Notes:
Webhook Method: Ensure you use the correct live stream ID and provide accurate metadata in JSON format.
Now Playing API: Make sure your API is functional and provides the necessary live stream data.
Still need help?
Contact us