Welcome to the BeeStreamed API documentation. This API allows you to interact with the BeeStreamed platform programmatically, enabling you to manage streaming events, analyze viewer data, and engage with your audience.
All API requests require authentication using an access token. Include your token in the request header:
Authorization: Basic base64_encode({token_id}:{secret_key})The API is organized around these main resources:
The API implements rate limiting to ensure fair usage:
If you exceed these limits, you'll receive a 429 Too Many Requests response.
All API responses are returned in JSON format and include a status field indicating the HTTP status code.
The API uses standard HTTP status codes to indicate success or failure:
Error responses include a message explaining what went wrong.
All API requests to Beestreamed require authentication using access tokens. Access tokens provide a secure way to authenticate requests without exposing sensitive credentials.
New access tokens can be created in the Manage Panel.
Include your access token in the Authorization header of your HTTP request using Basic authentication:
Authorization: Basic base64_encoded({token_id}:{secret_key})Where base64_encoded({token_id}:{secret_key}) is the Base64 encoding of your token ID and secret key joined by a colon.
# If your token_id is "abc123" and secret_key is "xyz789"
# First, encode "abc123:xyz789" in Base64, which gives "YWJjMTIzOnh5ejc4OQ=="
curl -X GET "https://api.beestreamed.com/events" \
-H "Authorization: Basic YWJjMTIzOnh5ejc4OQ=="const tokenId = 'abc123';
const secretKey = 'xyz789';
const credentials = btoa(`${tokenId}:${secretKey}`);
fetch('https://api.beestreamed.com/events', {
headers: {
'Authorization': `Basic ${credentials}`
}
})
.then(response => response.json())
.then(data => console.log(data));Access token requests are subject to rate limiting. The current limits are:
Exceeding these limits will result in HTTP 429 (Too Many Requests) responses.
The Events API allows you to create, manage, and control streaming events for your channel on the BeeStreamed platform. This introduction covers the key concepts and available endpoints.
Events can have the following status values:
idle - Event is created but not yet streaminglive - Event is currently streamingvideo - Event is showing recorded video contentdone - Event has endedforce_live - Event is forced to live state (for WebRTC)Each event can have various features enabled or disabled:
Get event details for a specific event.
URL : /events/[EVENT_REF]
Method : GET
Authentication required : YES
Rate Limiting:
Code : 200 OK
{
"event_chat": false,
"event_client_ref": "abcd1234",
"event_created": "2023-09-21 15:43:05",
"event_date": "2023-09-23 17:43:05",
"event_desc": "This is a description of my event",
"event_embed_domain": null,
"event_id": 12345678,
"event_image": "my_cool_thumbnail.jpg",
"event_mux": "abdcefghijklmnopqrstuvwxyz0123456789",
"event_mux_playback": null,
"event_password": null,
"event_qa": true,
"event_recurring": 0,
"event_ref": "abcd12345678",
"event_signup": null,
"event_signup_form_msg": null,
"event_signup_required": false,
"event_signup_success_msg": null,
"event_status": "live",
"event_title": "A cool title",
"event_user_ref": "ABCD1234",
"event_webrtc": false
}{
"event_chat": false,
"event_date": "2023-09-23 17:43:05",
"event_desc": "This is a description of my event",
"event_mux_playback": null,
"event_qa": true,
"event_signup": null,
"event_signup_form_msg": null,
"event_signup_required": false,
"event_signup_success_msg": null,
"event_status": "live",
"event_title": "A cool title"
}Condition : Event not found
Code : 404 NOT FOUND
{
"message": "Event with REF {event_ref} not found",
"status": 404
}Condition : Not authorized to access event
Code : 403 FORBIDDEN
{
"message": "You are not authorized to access this event",
"status": 403
}Get all events from the authenticated user.
URL : /events
Method : GET
Parameters
INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)STRING status (default all) idle, live, done or videoSTRING orderBy (default event created date) created / startDateSTRING startDateFrom (Start date is start time of event)STRING startDateToSTRING search (Anything in title or description can be matched here)Authentication required : YES
Code : 200 OK
User API key
[
{
"event_chat": false,
"event_client_ref": "abcd1234",
"event_created": "2023-09-21 15:43:05",
"event_date": "2023-09-23 17:43:05",
"event_desc": "This is a description of my event",
"event_embed_domain": null,
"event_id": 12345678,
"event_image": "my_cool_thumbnail.jpg",
"event_mux": "abdcefghijklmnopqrstuvwxyz0123456789",
"event_mux_playback": null,
"event_password": null,
"event_qa": true,
"event_recurring": 0,
"event_ref": "abcd12345678",
"event_signup": null,
"event_signup_form_msg": null,
"event_signup_required": false,
"event_signup_success_msg": null,
"event_status": "live",
"event_title": "A cool title",
"event_user_ref": "ABCD1234"
},
{
"event_chat": false,
"event_client_ref": "abcd1234",
"event_created": "2023-09-27 12:11:53",
"event_date": "2023-10-12 10:30:00",
"event_desc": "I have a different description for my event",
"event_embed_domain": null,
"event_id": 87654321,
"event_image": "this_is_also_a_cool_thumbnail.jpg",
"event_mux": "0123456789abdcefghijklmnopqrstuvwxyz",
"event_mux_playback": null,
"event_password": null,
"event_qa": true,
"event_recurring": 0,
"event_ref": "abcd12345678",
"event_signup": null,
"event_signup_form_msg": null,
"event_signup_required": false,
"event_signup_success_msg": null,
"event_status": "video",
"event_title": "Another really cool title",
"event_user_ref": "1234ABCD"
}
]Creating a new event as a user
URL : /events
Method : POST
Authentication required : YES
Code : 201 Created
User API key
{
"event_ref": "abcd12345678",
"message": "Event created"
}Update the event data using available parameters
URL : /events/[EVENT REF]
Method : PATCH
Parameters
STRING titleSTRING desc or descriptionSTRING date (Must be formatted)STRING status (idle, live, video, done or force_live)STRING signup_form (Formatted with commas between each input i.e "Name, Email")STRING signup_success_msg (You can reference the signup input value with brackets enclosing the input name. i.e [Name])STRING signup_form_msgSTRING signup_terms (Define custom terms for the signup form)STRING image (Idle thumbnail of event)STRING lang (Choose language of event, default is English "en")STRING qa_form_text (Define the text inside the Q&A form)BOOL signup (Signup toggle)BOOL chat (Chat toggle)BOOL qa (Q&A toggle)BOOL show_countdown (Countdown toggle)BOOL qa_email_required (Toggle email as a required input for joining qa)BOOL video_auto_Switch (Automatically switch the video to the newest finished live stream)BOOL save_stream_in_videos (Save live stream in to videos when live stream is done)BOOL save_stream_in_videos (Save live stream in to videos when live stream is done)BOOL show_logo (Toggle logo on event)Authentication required : YES
Code : 200 OK
User API key
{
"message": "Event updated",
"rows": 1
}Permanently deletes a specified event
URL : /events/[EVENT REF]
Method : DELETE
Authentication required : YES
Code : 200 OK
User API key
{
"message": "Event deleted",
"rows": 1
}Get image url from specific event
URL : /events/[EVENT REF]/image
Method : GET
Authentication required : YES
Code : 200 OK
User API key + Global authentication
{
"data": {
"signed_url": "https://liveplatform-bucket-1.s3.eu-central-1.amazonaws.com/images/standard_webinar_dark.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEKv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDGV1LWNlbnRyYWwtMSJIMEYCIQCXvhDTLQ7VAixrAZA%2F%2BnxoqTVeiJuVGrc%2FdyDPdRdM4gIhAOGOz8sUW6JCC13ZbWPmIpk3XzFR1zufm8V3mw%2BvQvOcKs4FCNT%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQARoMNjk2NTg4NDM1MzYxIgyBb6AptrtNlTSifcwqogUh9qPiQn9BUECGtrAY54U4Fl%2FjSpfWZz5g4DEOvqDMpM%2F26KASNXnTTj1FGoiuiQTXqpQk5gUhyeHhHVIjgtP74A5j1e37Z4eBFURVlx6VLe%2BkPykJvDnfi0DxmgHa0icUoWEI4z7jfX2s339tQ49TU%2BKLkzL4zXrCiv7wQY%2B%2FTqmt6jQKPISciI7ycYsW4WbHlxvjhNJBA%2BwJqbfshNrZNrXlGvpZBqtRwMfS8EDvgB3BdmjHyg8CuLk8BIdUgbtoiSY0wTLqOU2fqy2DgFQMbLPF6eXxymSznBnRVSi5XF6kwcmiwdYNe2LLGz%2FM40ic3HfAfTU2zgBfU1qY7c5%2BqYYWOEX6jRPH%2BVzKyRduasFy6j1CWzjO3xhVOW1jHx01D96URhv%2B0vJZNDg8c8jxv%2BSfa3CtyRRgQY06Zz5dLDWhYJUuzIf%2F2zV1dljnF8rjrOAbVFQ9XJPzBDWOt151s9mPExEJW2U1Gdr1Oi%2FYjgfTDo4wFJD7s2Reo5l1ZtwDXfLrAU89LjFpaP9hwhyT%2BM40WgKwoG8UawsOEaWS4l5oJrEp6uBzM8sG9XO%2BzG8qEFJddgEynNe0euxhEizQZNZpb3DmuCwNebL%2FRVuot7MYJcY0VEUbB5Yu9SdL6TQ1kX%2BV4DnqIQIxz%2Bic%2FhxqaDJHpis5Eik72yrcLClXbODvbqtuYpjO1bgi8htSL8znTdm7UBRblS8GEtqf%2BGT1WhTmgKFnKedsBo%2FXUSsrl8dxX4DnnsG%2FNoKBKA9fJsemAn95%2FlJpdbxXYDpUeEqY03OQRM65z7ZelJkUCc63AKkK3PDVs6AdxmtqR4E8zUNnzEr6Ywnuh9KBhOnxpIHYMxj3e3yhkEVAv4cpizXUe3XtYNqAEUsYxEckDq3ZMKZ9dTDGm%2F6pBjqwAVpLyJkFjfiXIHU%2B17IJwGh%2B8sJJqoGs0Z9TYt4mPjL40AE8n%2BvTaUiXV471YijkvFUQY100DamD7exBjijFRwhdDhisKyvTil4HTl3VnMM%2Bo2Lx1yStRaxWXEiL6WEkNrr1nAtmHrcchROTnyxeS%2BIbhg2%2FX2BDTfWk3gHLpHKwQ9AHz3zjRtmLxR3nGv5b5KIySaLVBY6s4ZxfZtDmM5JXKQk8Wdp8P1DqFxRy8tcj&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2EL7H76Q77GABGXP%2F20231030%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20231030T111039Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=688ca0334edefae39057f6371f023d1fc6d85920bd7720c191c51f1f108d4283"
},
"status": 200
}
}Get stream data from MUX for a specific event; this includes stream status, view data and simulcast targets.
URL : /events/[EVENT REF]/stream
Method : GET
Authentication required : YES
Code : 200 OK
{
"data": {
"view_data": [
{
"views": 0,
"viewers": 0,
"updated_at": "0001-01-01T00:00:00Z"
}
],
"status": "idle",
"reconnect_window": 60,
"simulcast_targets": [
{
"id": "A1b2C3d4E5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0",
"passthrough": "Target name",
"status": "idle",
"stream_key": "A1B2C3D4-E5F6G7H8-I9J0K1L2-M3N4O5P6",
"url": "rtmps://global-live.mux.com:443/app"
}
]
},
"status": 200
}views : Total number of views for the streamviewers : Current number of active viewersupdated_at : Timestamp of last view data updatestatus : Current stream status (idle, active, etc.)reconnect_window : Time window in seconds for stream reconnectionid : Unique identifier for the simulcast targetpassthrough : Display name or identifier for the targetstatus : Current status of the simulcast targetstream_key : Stream key for the target platformurl : RTMP URL for the target platformGet list of logs from a specific event
URL : /events/[EVENT REF]/log
Method : GET
Authentication required : YES
Code : 200 OK
User API key
[
{
"events_log_client_ref": "g5zp39",
"events_log_created": "2024-06-19 10:58:48",
"events_log_event_ref": "bnomxr897pqw",
"events_log_id": 6561,
"events_log_ref": "giiqj9jp5q0s",
"events_log_response": {
"webrtc": true
},
"events_log_type": "update",
"events_log_user_ref": "E0QRGZ",
"row_num": 293
},
{
"events_log_client_ref": "g5zp39",
"events_log_created": "2024-06-19 10:29:56",
"events_log_event_ref": "bnomxr897pqw",
"events_log_id": 6556,
"events_log_ref": "60xvodpldhul",
"events_log_response": {
"webrtc": false
},
"events_log_type": "update",
"events_log_user_ref": "E0QRGZ",
"row_num": 292
}
]Get RTMP key from specific event
URL : /events/[EVENT REF]/rtmp
Method : GET
Authentication required : YES
Code : 200 OK
User API key
{
"data": {
"key": "aee49e2b-c0e6-08c7-cea1-56dbd9fafb9b",
"server": "rtmps://global-live.mux.com:443/app"
},
"status": 200
}Send bulk emails for signups on specific event
URL : /events/[EVENT REF]/sendemails
Method : POST
Parameters
BOOL excludeSent (Excludes everyone that has already received an email)BOOL excludeNotSent (Excludes everyone that hasn't received an email)Authentication required : YES
Code : 200 OK
User API key
{
"message": "Emails sent successfully",
"status": 200
}Remove a simulcast target from an event
URL : /events/[EVENT REF]/simulcast
Method : DELETE
Query Parameters :
target_id=[string] : ID of the simulcast target to deleteAuthentication required : YES
Code : 200 OK
Content
{
"message": "Simulcast target deleted",
"status": 200
}Condition : If target_id is missing
Code : 400 BAD REQUEST
{
"error": "target_id_required",
"status": 400
}Condition : If deletion fails
Code : 400 BAD REQUEST
{
"error": "delete_failed",
"status": 400
}Create a new simulcast target for a specific event
URL : /events/[EVENT REF]/simulcast
Method : POST
Authentication required : YES
Request Body
{
"url": "rtmp://a.rtmp.youtube.com/live2",
"passthrough": "youtube-stream",
"stream_key": "xxxx-xxxx-xxxx-xxxx"
}Success Response
Code : 200 OK
Content
{
"message": "Simulcast target created",
"status": 200
}url, passthrough, and stream_keyStart WebRTC stream for a specific event
URL : /events/[EVENT REF]/startwebrtcstream
Method : POST
Authentication required : YES
Code : 200 OK
User API key
{
"message": "Livestream started",
"status": 200
}Stop WebRTC stream for a specific event
URL : /events/[EVENT REF]/stopwebrtcstream
Method : POST
Authentication required : YES
Code : 200 OK
User API key
{
"message": "Livestream ended successfully",
"status": 200
}Get current stream stats from specific event
URL : /events/[EVENT REF]/stream
Method : GET
Authentication required : YES
Code : 200 OK
User API key
{
"data": {
"reconnect_window": 60,
"status": "disabled",
"view_data": [
{
"updated_at": "0001-01-01T00:00:00Z",
"viewers": 0,
"views": 0
}
]
},
"status": 200
}Creating a new event image as a user
URL : /events/[EVENT REF]/upload
Method : POST
Parameters
STRING filename (Full file name with extenstion. Extenstions must be of types png, jpg or jpeg)Authentication required : YES
Code : 201 Created
User API key
{
"data": {
"asset_ref": "abcdefgh12345678",
"upload_url": "https://liveplatform-bucket-1.s3.eu-central-1.amazonaws.com/images/abcdefgh1234.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEKv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDGV1LWNlbnRyYWwtMSJIMEYCIQCXvhDTLQ7VAixrAZA%2F%2BnxoqTVeiJuVGrc%2FdyDPdRdM4gIhAOGOz8sUW6JCC13ZbWPmIpk3XzFR1zufm8V3mw%2BvQvOcKs4FCNT%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQARoMNjk2NTg4NDM1MzYxIgyBb6AptrtNlTSifcwqogUh9qPiQn9BUECGtrAY54U4Fl%2FjSpfWZz5g4DEOvqDMpM%2F26KASNXnTTj1FGoiuiQTXqpQk5gUhyeHhHVIjgtP74A5j1e37Z4eBFURVlx6VLe%2BkPykJvDnfi0DxmgHa0icUoWEI4z7jfX2s339tQ49TU%2BKLkzL4zXrCiv7wQY%2B%2FTqmt6jQKPISciI7ycYsW4WbHlxvjhNJBA%2BwJqbfshNrZNrXlGvpZBqtRwMfS8EDvgB3BdmjHyg8CuLk8BIdUgbtoiSY0wTLqOU2fqy2DgFQMbLPF6eXxymSznBnRVSi5XF6kwcmiwdYNe2LLGz%2FM40ic3HfAfTU2zgBfU1qY7c5%2BqYYWOEX6jRPH%2BVzKyRduasFy6j1CWzjO3xhVOW1jHx01D96URhv%2B0vJZNDg8c8jxv%2BSfa3CtyRRgQY06Zz5dLDWhYJUuzIf%2F2zV1dljnF8rjrOAbVFQ9XJPzBDWOt151s9mPExEJW2U1Gdr1Oi%2FYjgfTDo4wFJD7s2Reo5l1ZtwDXfLrAU89LjFpaP9hwhyT%2BM40WgKwoG8UawsOEaWS4l5oJrEp6uBzM8sG9XO%2BzG8qEFJddgEynNe0euxhEizQZNZpb3DmuCwNebL%2FRVuot7MYJcY0VEUbB5Yu9SdL6TQ1kX%2BV4DnqIQIxz%2Bic%2FhxqaDJHpis5Eik72yrcLClXbODvbqtuYpjO1bgi8htSL8znTdm7UBRblS8GEtqf%2BGT1WhTmgKFnKedsBo%2FXUSsrl8dxX4DnnsG%2FNoKBKA9fJsemAn95%2FlJpdbxXYDpUeEqY03OQRM65z7ZelJkUCc63AKkK3PDVs6AdxmtqR4E8zUNnzEr6Ywnuh9KBhOnxpIHYMxj3e3yhkEVAv4cpizXUe3XtYNqAEUsYxEckDq3ZMKZ9dTDGm%2F6pBjqwAVpLyJkFjfiXIHU%2B17IJwGh%2B8sJJqoGs0Z9TYt4mPjL40AE8n%2BvTaUiXV471YijkvFUQY100DamD7exBjijFRwhdDhisKyvTil4HTl3VnMM%2Bo2Lx1yStRaxWXEiL6WEkNrr1nAtmHrcchROTnyxeS%2BIbhg2%2FX2BDTfWk3gHLpHKwQ9AHz3zjRtmLxR3nGv5b5KIySaLVBY6s4ZxfZtDmM5JXKQk8Wdp8P1DqFxRy8tcj&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2EL7H76Q77GABGXP%2F20231030%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20231030T112939Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=46bc0d477c2e6749255abf0402c332dfcd5db5162cb881cc441acd02b808165d"
},
"message": "Asset created",
"status": 201
}The Analytics API provides access to viewer statistics and engagement metrics for your streams and videos.
The API provides access to various metrics:
Most analytics endpoints accept a timeframe parameter to specify the time range for the data:
timeframe=1609459200,1612137600This represents a start and end timestamp in Unix time format (seconds since epoch).
All analytics endpoints require authentication via:
Authorization: Basic {token_id}:{token_secret}Analytics endpoints follow the standard rate limiting:
Many analytics endpoints support these common parameters:
timeframe : Comma-separated Unix timestamps (start,end)limit : Number of results per page (default varies by endpoint)page : Page number for pagination Get aggregate metrics for an event.
URL : /analytics/[EVENT REF]/overall
Method : GET
Authentication required : YES
Query Parameters :
metric_id : Type of metric to measure (default: "views")measurement : Type of measurement to perform (default: "count")timeframe : Unix timestamps in seconds (format: "start_timestamp,end_timestamp")Code : 200 OK
{
"data": {
"metric": "metric_name",
"value": "aggregate_value",
"measurement": "measurement_type"
},
"status": 200
}Condition : Not authorized to access event
Code : 403 FORBIDDEN
{
"message": "You are not authorized to access this event",
"status": 403
}Get time-based analytics data for viewing patterns.
URL : /analytics/[EVENT REF]/timeseries
Method : GET
Authentication required : YES
Query Parameters :
group_by : Time unit to group the data by (default: "minute") (options: "day", "hour", "ten_minute", "minute") Timeframe must be less than 1 hour for "minute" and 6 hours for "ten_minute".timeframe : Unix timestamps in seconds (format: "start_timestamp,end_timestamp")Code : 200 OK
{
"data": [
{
"timestamp": "unix_timestamp",
"value": "view_count"
}
],
"status": 200
}Condition : Not authorized to access event
Code : 403 FORBIDDEN
{
"message": "You are not authorized to access this event",
"status": 403
}Get analytics data grouped by specific criteria for an event.
URL : /analytics/[EVENT REF]/breakdown
Method : GET
Authentication required : YES
Query Parameters :
metric_id : Type of metric to analyze (default: "views")group_by : (Required) Criteria to group the data bytimeframe : Unix timestamps in seconds (format: "start_timestamp,end_timestamp")Code : 200 OK
{
"data": [
{
"group": "group_value",
"value": "metric_value"
}
],
"status": 200
}Condition : Missing required group_by parameter
Code : 400 BAD REQUEST
{
"message": "Group by is required",
"status": 400
}Condition : Not authorized to access event
Code : 403 FORBIDDEN
{
"message": "You are not authorized to access this event",
"status": 403
}Get detailed view data for an event.
URL : /analytics/[EVENT REF]/views
Method : GET
Authentication required : YES
Query Parameters :
timeframe : Unix timestamps in seconds (format: "start_timestamp,end_timestamp")limit : Number of results per page (default: 25)page : Page number for pagination (default: 1)order : Sort order for results (default: "desc", options: "asc" or "desc")Code : 200 OK
{
"data": {
"views": [
{
"view_id": "string",
"view_start": "timestamp",
"view_end": "timestamp",
"view_duration": "integer"
}
],
"total_row_count": "integer",
"timeframe": ["start_timestamp", "end_timestamp"]
},
"status": 200
}Condition : Not authorized to access event
Code : 403 FORBIDDEN
{
"message": "You are not authorized to access this event",
"status": 403
}Get detailed viewer data for a specific viewer of an event.
URL : /analytics/[EVENT REF]/viewers/[VIEWER ID]
Method : GET
Authentication required : YES
Query Parameters :
timeframe : Unix timestamps in seconds (format: "start_timestamp,end_timestamp")limit : Number of results per page (default: 25)page : Page number for pagination (default: 1)order : Sort order for results (default: "desc", options: "asc" or "desc")Code : 200 OK
{
"data": {
"viewer_data": {
"viewer_id": "string",
"first_view": "timestamp",
"last_view": "timestamp",
"total_views": "integer",
"total_duration": "integer"
},
"interaction_data": {
// Optional additional interaction data if available
}
},
"status": 200
}Condition : Viewer ID is required
Code : 400 BAD REQUEST
{
"message": "Viewer ID is required",
"status": 400
}Condition : Not authorized to access event
Code : 403 FORBIDDEN
{
"message": "You are not authorized to access this event",
"status": 403
}The Chat API allows you to manage chat messages and interactions for your streaming events.
The Chat API supports two types of messaging:
Chat messages can have different status values:
public - Visible to all viewershidden - Hidden from public view (moderated)Q&A messages can have these status values:
new - Newly submitted questionapproved - Question approved for displayarchived - Question archived (no longer active)The API allows for message moderation through the PATCH endpoint, enabling:
All chat endpoints require authentication via:
Authorization: Basic {token_id}:{token_secret}Chat endpoints follow the standard rate limiting:
The chat system supports two types of messages:
qa=true)Messages can have different status values depending on type:
Chat messages:
public - Visible to all usershidden - Hidden from public viewQ&A messages:
approved - Approved for displayarchived - Archived and hidden Get chat messages in a list form, choose how many results you want and which page you want to see.
URL : /chat/[EVENT REF]
Method : GET
Parameters
BOOL qa (default false)INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)Authentication required : YES
Code : 200 OK
User API key
[
{
"chat_created": "2023-10-17 15:52:10",
"chat_deleted_time": null,
"chat_email": "john@doe.com",
"chat_event_ref": "abcd12345678",
"chat_id": 33,
"chat_message": "I'm writing in the chat right now",
"chat_name": "John Doe",
"chat_ref": "1234ABCD",
"chat_status": "public",
"row_num": 2
},
{
"chat_created": "2023-10-17 15:57:49",
"chat_deleted_time": null,
"chat_email": "joe@mama.com",
"chat_event_ref": "abcd12345678",
"chat_id": 34,
"chat_message": "This is Joe's mama writing",
"chat_name": "Joe Mama",
"chat_ref": "ABCD1234",
"chat_status": "public",
"row_num": 1
}
]Global authentication
[
{
"chat_created": "2023-10-17 15:52:10",
"chat_id": 33,
"chat_message": "I'm writing in the chat right now",
"chat_name": "John Doe",
"chat_ref": "1234ABCD",
"row_num": 1
},
{
"chat_created": "2023-10-17 15:57:49",
"chat_id": 33,
"chat_message": "This is Joe's mama writing",
"chat_name": "Joe Mama",
"chat_ref": "ABCD1234",
"row_num": 1
}
]Creating a new message on a specific event
URL : /chat/[EVENT REF]
Method : POST
Parameters
BOOL qa (default false)STRING name (required)STRING email (required)STRING message (required)Authentication required : YES
Code : 201 Created
Global authentication & User API key
{
"chat_ref": "ABCD1234",
"message": "Message created"
}Update the message data using available parameters
URL : /chat/[EVENT REF]/[CHAT/QA REF]
Method : PATCH
Parameters
STRING status (Chat: "public, hidden" Q&A: "approved, archived")Authentication required : YES
Code : 200 OK
User API key
{
"message": "Updated message",
"rows": 1
}The Polls API allows you to create and manage interactive polls for your streaming events. This introduction covers the key concepts and available endpoints for poll management.
A poll consists of:
Poll entries represent viewer responses to polls and include:
POST /events/{event_ref}/polls
{
"question": "What feature would you like to see next?",
"options": [
"Mobile app",
"More analytics",
"Custom branding",
"API improvements"
],
"active": true
}GET /events/{event_ref}/polls/{poll_ref}/entriesGet all polls for an event or get a specific poll
URL : /polls/[EVENT REF] or /polls/[EVENT REF]/[POLL REF]
Method : GET
Parameters (for listing polls)
INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)Authentication required : YES
Code : 200 OK
Response for poll list
{
"data": [
{
"poll_ref": "abc123",
"poll_event_ref": "event123",
"poll_question": "What is your favorite color?",
"poll_options": ["Red", "Blue", "Green"],
"poll_active": true,
"poll_created": "2024-01-20 15:30:00"
}
],
"status": 200
}Response for single poll
{
"data": {
"poll_ref": "abc123",
"poll_event_ref": "event123",
"poll_question": "What is your favorite color?",
"poll_options": ["Red", "Blue", "Green"],
"poll_active": true,
"poll_created": "2024-01-20 15:30:00"
},
"status": 200
}Create a new poll for a specific event
URL : /polls/[EVENT REF]
Method : POST
Request Body
{
"question": "What is your favorite color?",
"options": ["Red", "Blue", "Green"]
}Authentication required : YES
Code : 201 Created
{
"poll_ref": "abc123",
"message": "Poll created",
"status": 201
}question and options are required in the request bodyoptions must be an array of stringsUpdate poll state or add votes to poll options
URL : /polls/[EVENT REF]/[POLL REF]
Method : PATCH
Parameters For updating state:
BOOL state (Set poll active/inactive state)For voting:
BOOL vote (Must be true)INT option_index (Index of the option being voted for)STRING email (optional)STRING name (optional)Authentication required : YES
Code : 200 OK
Response for state update
{
"message": "Poll state updated",
"status": 200
}Response for vote
{
"message": "Vote updated",
"updated_rows": 1,
"status": 200
}Delete a specific poll
URL : /polls/[EVENT REF]/[POLL REF]
Method : DELETE
Authentication required : YES
Code : 200 OK
{
"message": "Poll deleted",
"status": 200
}Get all entries for a specific poll
URL : /polls/[EVENT REF]/[POLL REF]/entries
Method : GET
Parameters
INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)STRING search (Search by email or name)Authentication required : YES
Code : 200 OK
{
"data": [
{
"poll_entry_id": 123,
"poll_entry_poll_ref": "abc123",
"poll_entry_email": "user@example.com",
"poll_entry_name": "John Doe",
"poll_entry_option_index": 1,
"poll_entry_created": "2024-01-20 15:30:00",
"poll_entry_row_number": 1
}
],
"status": 200
}The Signup API allows you to manage event registrations and attendee information. This introduction will help you understand how to work with signup data and functionality.
Each event can have a customized signup form with various field types:
POST /events/{event_ref}/signup
{
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"custom_field": "Additional information"
}Get signup details from a specific event
URL : /signup/[EVENT REF]/[SIGNUP REF]
Method : GET
Authentication required : YES
Code : 200 OK
{
"signup_data":
{
"name": "John Doe",
"email": "john@doe.com",
"company": "Doe Corp."
},
"signup_date": "2023-09-06 11:25:35",
"signup_date_visited": null,
"signup_email_sent": 1,
"signup_ref": "abcdefghijklmn1234567890",
"signup_visited": 0
}Creating a new signup on a specific event
URL : /signup/[EVENT REF]
Method : POST
Parameters
Parameters may be defined by the users on each event. Check "event_signup" data column under "Get event details" for an example of this.
STRING name (required)STRING email (required)STRING message (required)Authentication required : YES
Code : 201 Created
Global authentication & User API key
{
"signup_ref": "ABCD1234",
"message": "Signup created"
}Get all signups from the authenticated user.
URL : /signup/[EVENT REF]
Method : GET
Parameters
INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)Authentication required : YES
Code : 200 OK
User API key
[
{
"row_num": 2,
"signup_data":
{
"name": "John Doe",
"email": "john@doe.com",
"company": "Doe Corp."
},
"signup_date": "2023-10-23 22:07:37",
"signup_date_visited": "2023-10-25 12:14:34",
"signup_email_sent": 1,
"signup_event_ref": "abcdefgh1234",
"signup_id": 12,
"signup_ref": "abcdefghijklmn1234567890",
"signup_visited": 1
},
{
"row_num": 1,
"signup_data":
{
"name": "Joe Mama",
"email": "joe@mama.com",
"company": "Joe's Mama's Bakery"
},
"signup_date": "2023-10-23 22:06:09",
"signup_date_visited": null,
"signup_email_sent": 0,
"signup_event_ref": "abcdefgh1234",
"signup_id": 12,
"signup_ref": "1234567890abcdefghijklmn",
"signup_visited": 0
},
]The Videos API allows you to manage video content in your Beestreamed account.
Videos can have the following status values:
processing - Video is being processedready - Video is ready for playbackerror - Video processing encountered an errordeleted - Video has been marked for deletionEach video can have various features enabled or disabled:
Get details from a specific video
URL : /videos/[VIDEO REF]
Method : GET
Authentication required : YES
Code : 200 OK
User API key
{
"data": {
"video_client_ref": "g5zp39",
"video_date": "2024-06-19 10:17:54",
"video_delete_date": 0,
"video_deleted": 0,
"video_delivery_current": 72,
"video_delivery_next_update": 1719009155,
"video_delivery_paid": 0,
"video_event_ref": null,
"video_id": 275,
"video_mux_asset_id": "LGbqMZ8lS213tmO1OPCSA9bbqiWorz001iuiO3WG0168Y",
"video_mux_data": {
"asset_id": "LGbqMZ8lS213tmO1OPCSA9bbqiWorz001iuiO3WG0168Y",
"details": {
"aspect_ratio": "16:9",
"frame_rate": 24,
"resolution": "1080p",
"resolution_tag": "HD"
},
"duration": 78.95833333333333,
"playback_id": "JOlubbhBPwU6HPktGkgrh6T3yzN7EAPe1hdcST6b9pQ"
},
"video_mux_sync": 0,
"video_ref": "pvg36jbfxxmdtochgwjtdcnuyp1tve1o",
"video_title": "TEST STREAM FOR VIDEOSDK"
},
"status": 200
}Get all videos from the authenticated user.
URL : /videos
Method : GET
Parameters
INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)STRING startDateFrom (Start date is creation date of video)STRING startDateToSTRING search (Anything in title)Authentication required : YES
Code : 200 OK
User API key
{
"data": [
{
"row_num": 12,
"video_client_ref": "g5zp39",
"video_date": "2024-06-19 10:17:54",
"video_delete_date": 0,
"video_deleted": 0,
"video_delivery_current": 72,
"video_delivery_next_update": 1719009155,
"video_delivery_paid": 0,
"video_event_ref": null,
"video_id": 275,
"video_mux_asset_id": "LGbqMZ8lS213tmO1OPCSA9bbqiWorz001iuiO3WG0168Y",
"video_mux_data": {
"asset_id": "LGbqMZ8lS213tmO1OPCSA9bbqiWorz001iuiO3WG0168Y",
"details": {
"aspect_ratio": "16:9",
"frame_rate": 24,
"resolution": "1080p",
"resolution_tag": "HD"
},
"duration": 78.95833333333333,
"playback_id": "JOlubbhBPwU6HPktGkgrh6T3yzN7EAPe1hdcST6b9pQ"
},
"video_mux_sync": 0,
"video_ref": "pvg36jbfxxmdtochgwjtdcnuyp1tve1o",
"video_title": "TEST STREAM FOR VIDEOSDK"
},
{
"row_num": 11,
"video_client_ref": "g5zp39",
"video_date": "2024-06-18 14:10:47",
"video_delete_date": 0,
"video_deleted": 0,
"video_delivery_current": 932,
"video_delivery_next_update": 1719023682,
"video_delivery_paid": 0,
"video_event_ref": "wdml7mti13cz",
"video_id": 274,
"video_mux_asset_id": "H02LZjuDqHWwSbVo4wlPR024bYNWL1yBZRg8wUyE4jZpA",
"video_mux_data": {
"asset_id": "H02LZjuDqHWwSbVo4wlPR024bYNWL1yBZRg8wUyE4jZpA",
"details": {
"aspect_ratio": "16:9",
"frame_rate": 25,
"resolution": "1080p",
"resolution_tag": "UHD"
},
"duration": 88.884,
"playback_id": "w4qmVq51YP0002Pz7ArakmEMYEMWEmHRibqy4p9REnKNQ"
},
"video_mux_sync": 1,
"video_ref": "lio2wth4jyo53pwa8at7uu895vqqez22",
"video_title": "Experian - Innovation Summit 2024 - with subtitles.mp4"
},
{
"row_num": 10,
"video_client_ref": "g5zp39",
"video_date": "2024-06-18 14:06:37",
"video_delete_date": 0,
"video_deleted": 0,
"video_delivery_current": 1528,
"video_delivery_next_update": 1719023675,
"video_delivery_paid": 0,
"video_event_ref": "s3u7ph3tbuvk",
"video_id": 273,
"video_mux_asset_id": "Igs01HNyekAvRlakbyP8Mz99wyv1yAgXOUTGXK5oeye00",
"video_mux_data": {
"asset_id": "Igs01HNyekAvRlakbyP8Mz99wyv1yAgXOUTGXK5oeye00",
"details": {
"aspect_ratio": "16:9",
"frame_rate": 25,
"resolution": "1080p",
"resolution_tag": "UHD"
},
"duration": 66.275667,
"playback_id": "tYBjsyej01YHC02VSwj004Mi9Y02fCXjwKUeT8F6Na00GSeI"
},
"video_mux_sync": 1,
"video_ref": "whclyu2vput6gplz5yf6x7vjwe1k3216",
"video_title": "Wunderman20230220_Ad_video_done.mp4"
},
{
"row_num": 9,
"video_client_ref": "g5zp39",
"video_date": "2024-06-14 17:46:16",
"video_delete_date": 0,
"video_deleted": 0,
"video_delivery_current": 270,
"video_delivery_next_update": 1718998347,
"video_delivery_paid": 0,
"video_event_ref": null,
"video_id": 233,
"video_mux_asset_id": "p42VC2gKhyegTPVaFVFoS63Nkq02PTOhiGwkYdeEL8Xs",
"video_mux_data": {
"asset_id": "p42VC2gKhyegTPVaFVFoS63Nkq02PTOhiGwkYdeEL8Xs",
"details": {
"aspect_ratio": "16:9",
"frame_rate": 24,
"resolution": "720p",
"resolution_tag": "HD"
},
"duration": 447.75,
"playback_id": "Qx3KNC9XHJGqjC6VGXP1F6XQgKfykTo388QZsZ12jXk"
},
"video_mux_sync": 1,
"video_ref": "dqnetln5a5kxgd2hp4lly62ef8d6mv4n",
"video_title": "Upgrading an M1 MacBook Air to 2TB! - SSD Storage Upgrade.mp4"
},
{
"row_num": 8,
"video_client_ref": "g5zp39",
"video_date": "2024-06-07 15:11:33",
"video_delete_date": 0,
"video_deleted": 0,
"video_delivery_current": 716,
"video_delivery_next_update": 1718983924,
"video_delivery_paid": 0,
"video_event_ref": null,
"video_id": 231,
"video_mux_asset_id": "K6TomEQMuyywCiUsw9gu024Y9Vg7SOWowjrpGEFgaTEQ",
"video_mux_data": {
"asset_id": "K6TomEQMuyywCiUsw9gu024Y9Vg7SOWowjrpGEFgaTEQ",
"details": {
"aspect_ratio": "16:9",
"frame_rate": 30,
"resolution": "1080p",
"resolution_tag": "HD"
},
"duration": 67.533333,
"playback_id": "f012Atj3nqKxowRiGrLLKCavFxh00LnMV024re00lRuNZ84"
},
"video_mux_sync": 1,
"video_ref": "hlxg4vd1zqpqbjs4v56f8jn88nh8v508",
"video_title": "0103-africa.mp4"
}
],
"status": 200
}Creating a new video
URL : /videos
Method : POST
Parameters
STRING title (required)STRING asset_id (required) MUX Asset IDAuthentication required : YES
Code : 201 Created
User API key
{
"video_ref": "abcd12345678",
"message": "Video created",
"status": 201
}Update the video data using available parameters
URL : /videos/[VIDEO REF]
Method : PATCH
Parameters
STRING titleSTRING event_ref (Create link between event and video)Authentication required : YES
Code : 200 OK
User API key
{
"message": "Event updated",
"rows": 1
}Permanently deletes a specified video
URL : /videos/[VIDEO REF]
Method : DELETE
Authentication required : YES
Code : 200 OK
User API key
{
"message": "Video deleted",
"rows": 1
}Creates a new upload link for videos
URL : /videos/upload
Method : POST
Parameters
INT duration (required) Duration of video in secondsAuthentication required : YES
Code : 201 Created
User API key
{
"data": {
"data": {
"url": "https://storage.googleapis.com/video-storage-us-east1-uploads/zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc?Expires=1610112458&GoogleAccessId=mux-direct-upload%40mux-cloud.iam.gserviceaccount.com&Signature=LCu4PMoKUo%2BJkWQAUwB9WU4bWVVfW3K5bZxSxEptBz3DrjbFxNyGvs0sriyJupZh9Jdb6FxKWFIRbxEetfnAAiesOvSPH%2F1GlIichmGg3YfebfxiX77%2B6ToFF6FMkJucBo284PD90AVLHhKagOea2VsbdO0fh78MAxGH9sEspyQ2uJEfYWjHFqYQ9smJyIuM3CYOmN5HKPgRWy2yUqzV7OTMe%2FivPO4%2FX6XiiN2J4nTmy83252CJUsHIvbiGctfKxcNI6b23UVN4B1tJTVgyxTOZiBQCkMLkD%2FEe5OhoAkvJgkqENRr0q3swO0IChDDWjrh7OTMwqvWGwAoVXEGiHg%3D%3D&upload_id=ABg5-UznTdib1HhOAMjdHhWIYqBbwmSYM6dVKyPe3v33uTeEE8gkN5QzvR3cei6uSZOSrjPn7bdvvDH3nhsrLBq8AjWY2qE4UQ",
"timeout": 3600,
"status": "waiting",
"new_asset_settings": {
"playback_policies": [
"public"
],
"encoding_tier": "baseline",
"mp4_support": "capped-1080p"
},
"id": "zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc",
"cors_origin": "https://example.com/"
}
},
"status": 201
}Get upload status of specific upload
URL : /videos/upload/[UPLOAD ID]
Method : GET
Authentication required : YES
Code : 200 OK
User API key
{
"data": {
"timeout": 3600,
"status": "asset_created",
"new_asset_settings": {
"playback_policies": [
"public"
],
"encoding_tier": "baseline",
"mp4_support": "capped-1080p"
},
"id": "YzoCL01HHOtAVYq4Ds9zekdHJ2XqL9e8ukPWbr01KhtvM",
"asset_id": "AnFVqAVXfb7vVL3ypSQDMnJZunnb8nkwe02O00p2gK8P00"
}
}Gets master file of video as a download link
URL : /videos/[VIDEO REF]/master
Method : GET
Authentication required : YES
Code : 200 OK
User API key + Global authentication
Preparing download
{
"data": "preparing",
"status": 200
}Master download ready
{
"data": "https://master.mux.com/jEwsJfK02Ae2GQkPacSY4N2uts9EKiJC3/master.mp4?skid=default&signature=NjY3YTkxMWJfN2M0MzMzYzFiMTIyZTJjZjAxZmE1YzgyNDY5YWY0NjcyZDQ0ZjcxMTcxYTY1ZWYyYmIxZmI1NWYwY2RhYTQwMQ==",
"status": 200
}The Client API provides access to channel information and management features.
A channel has various resources and settings:
Channels are referenced as [Client REF or Client Subdomain]
Get public available channel details
URL : /client/[Client REF or Client Subdomain]
Method : GET
Authentication required : YES
Code : 200 OK
User API key
{
"client_id": 1,
"client_name": "My Company Name",
"client_ref": "abc123",
"client_subdomain": "mycompanyname"
},Global authentication
{
"client_name": "My Company Name",
"client_ref": "abc123",
"client_subdomain": "mycompanyname"
}Gets the image of the set channel logo
URL : /client/[Client REF or Client Subdomain]/image
Method : GET
Parameters
BOOL light (Set to true to retrieve light version of channel logo)Authentication required : YES
Code : 200 OK
User API key
{
"data": {
"signed_url": "https://liveplatform-bucket-1.s3.eu-central-1.amazonaws.com/images/17000445481061980967.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHYaDGV1LWNlbnRyYWwtMSJGMEQCIBljEZnZM%2BLN%2BBtHrfsZm3wpp2FKhwzb79gvimwdPZFfAiAdyCqFuJMTXhM0WniVEgTrLJKbrcv0ci2NgFce0J0pqSrOBQi%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDY5NjU4ODQzNTM2MSIMWVj%2BmP2fxY0r4yFuKqIFN1y4PCU3AEmnKPZJEqgfrYL0ytXjHUfhgpxIXMydphA8SeHsH9%2FLyVZglP4Wzcu6A0hmdmrixRfjosCdc2WaDbiem0hfzrOzVNDPx8be8r03doGb4q21E3ftrlmu2u6AJu5LfE53NS7ptIlxBXw%2BI7CyZ5P8qj9a4jgCbOmuu844hEh9wB9OE%2BszNQbfAheMrQZd20elk0Og90ZuzUv7cZ4jpf0IMLqsnsdOBCOusa7cmiLugDYc2YhZpZNgw274HdAE9G4RlDoeJ7TaVLiwAytLbPrfsU6lcsgkhhqdOnU7eK5YFMMa4TIj%2FsdjuKt5XwxXN1NtZ0oZjLckznPxQfYw5B92NscngloP3DQKCKemBSDbE1jDdLyq%2FwwWPMD2a9C%2Bf9LIJbgDOl%2B10yVuVcwN5SWXlaL%2FC9WLjUzz2QdkNu4D5r6VNNDqEu1qLX%2Ff6cWQG1b5vNuJLRK3hYVNJyukMYoGcxiGVbNEESsSnQg5ACAJVHHvAFIGaY8YEG9UGw41m5P1oZGF4FD0KipUSQDyZy8OYNhuUETLKZTw7L%2FHLldYHUcdhJfnAAOFRg9NbOB5CiVmHLbQhPeXTVpK3ObiIQ%2F3IchuU1P%2B7CX1hApcLTpMLETSFCpOoL%2FHzPiuAHKPLP12RrYYLUZQI48OrgajyG5d4Yz7KveMNdm6sQj%2BhxlK1095JlbUUFBNTjBoKS77bb2Omh6Rz6k6ryWboM%2B1wM%2FPYF5Zjmqo9zmdISCehHDU1mD1JqyZNTyV6OunmbcS%2FwcfN0j75GHQMyWgsJpKqyyowawsloagwGjaoDo1YTPxwuyRWYuXjEYbJlP52oCvmvreUy3dbGudKM2rzWhRhZg7FlVKqqdBmXJLwdsafEYMNN%2BCx31XarT5nocwO8Mw0PbiqgY6sgGEEJiVtKxz5QFljeFak0eoqLQOnA2zw4NzbklgAe%2BCrbMoMuxgwoxZ2whlccOMB%2BB%2FgBIwjHkUGZDu%2BNxYpoWzRvT6FN1dR4u2x79gPaiff7d5riaCDO6S792AxJ%2Fjiq7Mn8K7OfNvlU%2BjvfsNrfnGEaZjY3U4qwZgto9QthM%2FtGZ2%2B4DY9PGFKE6WefN670aiJqX%2FFb0YWDK6wtxPuxe1VZ%2F9yf9KF1fk5DWcL0NWdEy4&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2EL7H76QSGUDAQTQ%2F20231118%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20231118T141244Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=d7896553f15ad87627bea980b7f0268b60f9c4c6e4c95553c7164e9f2e578bd8"
},
"status": 200
}Uploads an image for the logo of the given client
URL : /client/[CLIENT REF or CLIENT SUBDOMAIN]/image
Method : POST
Parameters
STRING filename (required)Authentication required : YES
Code : 201 Created
Global authentication & User API key
{
"asset_ref": "ABCD1234",
"upload_url": "https://liveplatform-bucket-1.s3.eu-central-1.amazonaws.com/images/17000445481061980967.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHYaDGV1LWNlbnRyYWwtMSJGMEQCIBljEZnZM%2BLN%2BBtHrfsZm3wpp2FKhwzb79gvimwdPZFfAiAdyCqFuJMTXhM0WniVEgTrLJKbrcv0ci2NgFce0J0pqSrOBQi%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDY5NjU4ODQzNTM2MSIMWVj%2BmP2fxY0r4yFuKqIFN1y4PCU3AEmnKPZJEqgfrYL0ytXjHUfhgpxIXMydphA8SeHsH9%2FLyVZglP4Wzcu6A0hmdmrixRfjosCdc2WaDbiem0hfzrOzVNDPx8be8r03doGb4q21E3ftrlmu2u6AJu5LfE53NS7ptIlxBXw%2BI7CyZ5P8qj9a4jgCbOmuu844hEh9wB9OE%2BszNQbfAheMrQZd20elk0Og90ZuzUv7cZ4jpf0IMLqsnsdOBCOusa7cmiLugDYc2YhZpZNgw274HdAE9G4RlDoeJ7TaVLiwAytLbPrfsU6lcsgkhhqdOnU7eK5YFMMa4TIj%2FsdjuKt5XwxXN1NtZ0oZjLckznPxQfYw5B92NscngloP3DQKCKemBSDbE1jDdLyq%2FwwWPMD2a9C%2Bf9LIJbgDOl%2B10yVuVcwN5SWXlaL%2FC9WLjUzz2QdkNu4D5r6VNNDqEu1qLX%2Ff6cWQG1b5vNuJLRK3hYVNJyukMYoGcxiGVbNEESsSnQg5ACAJVHHvAFIGaY8YEG9UGw41m5P1oZGF4FD0KipUSQDyZy8OYNhuUETLKZTw7L%2FHLldYHUcdhJfnAAOFRg9NbOB5CiVmHLbQhPeXTVpK3ObiIQ%2F3IchuU1P%2B7CX1hApcLTpMLETSFCpOoL%2FHzPiuAHKPLP12RrYYLUZQI48OrgajyG5d4Yz7KveMNdm6sQj%2BhxlK1095JlbUUFBNTjBoKS77bb2Omh6Rz6k6ryWboM%2B1wM%2FPYF5Zjmqo9zmdISCehHDU1mD1JqyZNTyV6OunmbcS%2FwcfN0j75GHQMyWgsJpKqyyowawsloagwGjaoDo1YTPxwuyRWYuXjEYbJlP52oCvmvreUy3dbGudKM2rzWhRhZg7FlVKqqdBmXJLwdsafEYMNN%2BCx31XarT5nocwO8Mw0PbiqgY6sgGEEJiVtKxz5QFljeFak0eoqLQOnA2zw4NzbklgAe%2BCrbMoMuxgwoxZ2whlccOMB%2BB%2FgBIwjHkUGZDu%2BNxYpoWzRvT6FN1dR4u2x79gPaiff7d5riaCDO6S792AxJ%2Fjiq7Mn8K7OfNvlU%2BjvfsNrfnGEaZjY3U4qwZgto9QthM%2FtGZ2%2B4DY9PGFKE6WefN670aiJqX%2FFb0YWDK6wtxPuxe1VZ%2F9yf9KF1fk5DWcL0NWdEy4&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2EL7H76QSGUDAQTQ%2F20231118%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20231118T141244Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=d7896553f15ad87627bea980b7f0268b60f9c4c6e4c95553c7164e9f2e578bd8"
}Gets current estimated total usage for channel
URL : /client/[Client REF]/usage
Method : GET
Authentication required : YES
Code : 200 OK
User API key
{
"data": {
"currency": "eur",
"total": 15.138370833333333,
"types": {
"delivery_total": {
"cost": 0.2245375,
"unit_cost": 0.002875,
"usage": 78.1
},
"emails_total": {
"cost": 0.171,
"unit_cost": 0.003,
"usage": 57
},
"encoding_total": {
"cost": 14.626833333333334,
"unit_cost": 0.095,
"usage": 153.96666666666667
},
"ondemand_total": {
"cost": 0.116,
"unit_cost": 0.00725,
"usage": 16
}
}
},
"status": 200
}Get all user connections from channel
URL : /client/[CLIENT REF]/connections
Method : GET
Parameters
INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)STRING search (Anything in title or description can be matched here)BOOL active (default true)Authentication required : YES
Code : 200 OK
User API key
{
"data": [
{
"conn_ref": "UJBOHFzzTmN2tLFk5pv6QG22Rvby860R",
"conn_user_ref": "E0QRGZ",
"data": {
"user_client_ref": "g5zp39",
"user_email": "invoice@beestreamed.com",
"user_first": "Bee",
"user_last": "Streamed",
"user_ref": "E0QRGZ"
},
"row_num": 1
},
{
"conn_ref": "2smi2o66ifupm0wgc3p88gc7l81k3bho",
"conn_user_ref": "we3b2e3mtu7r",
"data": {
"user_client_ref": "g5zp39",
"user_email": "frederik.larsenbang@gmail.com",
"user_first": "Frederik",
"user_last": "Bang",
"user_ref": "we3b2e3mtu7r"
},
"row_num": 2
}
],
"status": 200
}Accept a channel connection
URL : /client/[Client REF]/connections
Method : POST
Parameters
STRING email (required)Authentication required : YES
Code : 200 OK
User Session key
{
"message": "Connection accepted!",
"status": 200
}Delete user connection
URL : /client/[CLIENT REF]/connections
Method : delete
Parameters
STRING connref (required)Authentication required : YES
Code : 200 OK
User Session key
{
"message": "Connection deleted!",
"status": 200
}The User API allows you to manage user accounts and preferences. This introduction will help you understand the available endpoints and concepts for user management.
The User API provides endpoints for managing user accounts, including:
All User API endpoints require authentication with a valid access token. User operations are restricted to the authenticated user's own account.
User data is handled according to our privacy policy. Personal information is protected and only accessible to the authenticated user or authorized administrators.
Delete organization connection
URL : /user/[SESSION KEY]/connections
Method : delete
Parameters
STRING connref (required)Authentication required : YES
Code : 200 OK
User Session key
{
"message": "Connection deleted!",
"status": 200
}Get all organization connections from user
URL : /user/[SESSION REF]/connections
Method : GET
Parameters
INT maxResults (default 10)INT page (default 1)INT indexStart (default latest entry)STRING search (Anything in title or description can be matched here)BOOL active (default true)Authentication required : YES
Code : 200 OK
User API key
{
"data": [
{
"conn_client_ref": "Ki0hne",
"conn_ref": "ANQSPe2oU51U5lR3UVvBJNiak7W6pmwS",
"data": {
"client_logo": "ol9vozodapjfo6et",
"client_logo_light": "8hlmoubhw4h9oc3q",
"client_name": "Experian",
"client_ref": "Ki0hne",
"client_subdomain": "experian"
},
"row_num": 1
},
{
"conn_client_ref": "g5zp39",
"conn_ref": "UJBOHFzzTmN2tLFk5pv6QG22Rvby860R",
"current": true,
"data": {
"client_logo": "5b8mpgkaocs5wb4v",
"client_logo_light": "y17li9bemabtzto0",
"client_name": "TestOrg",
"client_ref": "g5zp39",
"client_subdomain": "testorg"
},
"row_num": 2
}
],
"status": 200
}Accept an organization connection
URL : /user/[SESSION KEY]/connections
Method : POST
Parameters
STRING connref (required)Authentication required : YES
Code : 200 OK
User Session key
{
"message": "Connection accepted!",
"status": 200
}Webhooks is the recommended way to receive updates from Beestreamed. Please try and make use of the webhooks where usable instead of polling data. It's better for you and for us.
New webhooks can be created in the Manage Panel.
You are able to specify which types of data your webhook will listen for. You can choose one or multiple per webhook: "event, video, signup, poll and billing".
Each webhook will has it's own secret key which can be used to verify a webhooks posting data on your endpoint.
All webhooks are sent with the header X-Beestreamed-Signature. This signature can be used with your secret and verified via HMAC.
$payload = file_get_contents('php://input');
$receivedSignature = $_SERVER['HTTP_X_BEESTREAMED_SIGNATURE'] ?? '';
$secret = 'your_secret_here';
$expectedSignature = hash_hmac('sha256', $payload, $secret);
if (!hash_equals($expectedSignature, $receivedSignature)) {
http_response_code(401);
exit('Invalid signature');
}
echo 'Signature valid';const http = require('http');
const crypto = require('crypto');
const secret = 'your_secret_here';
const server = http.createServer((req, res) => {
if (req.method !== 'POST') {
res.writeHead(405);
return res.end('Method not allowed');
}
let body = '';
req.on('data', chunk => {
body += chunk;
});
req.on('end', () => {
const receivedSignature = req.headers['x-beestreamed-signature'] || '';
const expectedSignature = crypto
.createHmac('sha256', secret)
.update(body)
.digest('hex');
const isValid = crypto.timingSafeEqual(
Buffer.from(expectedSignature),
Buffer.from(receivedSignature)
);
if (!isValid) {
res.writeHead(401);
return res.end('Invalid signature');
}
res.writeHead(200);
res.end('Signature valid');
});
});
server.listen(3000);from flask import Flask, request, abort
import hmac
import hashlib
app = Flask(__name__)
secret = b'your_secret_here'
@app.route('/webhook', methods=['POST'])
def webhook():
payload = request.data
received_signature = request.headers.get('X-Beestreamed-Signature', '')
expected_signature = hmac.new(secret, payload, hashlib.sha256).hexdigest()
if not hmac.compare_digest(expected_signature, received_signature):
abort(401, 'Invalid signature')
return 'Signature valid'
if __name__ == '__main__':
app.run(port=3000)This webhook is triggered when a new invoice is created for a client.
{
"type": "billing.invoice.created",
"data": {
// Invoice data
}
}The billing.invoice.created webhook notifies you when a new invoice has been generated for a client. This typically happens at the end of a billing cycle.
This webhook is triggered when an invoice payment attempt has failed.
{
"type": "billing.invoice.payment.failed",
"data": {
// Invoice data
}
}The billing.invoice.payment.failed webhook notifies you when a payment attempt for an invoice has failed. This may be due to expired payment methods, insufficient funds, or other payment processing issues.
This webhook is triggered when an invoice payment is successfully processed.
{
"type": "billing.invoice.payment.succeeded",
"data": {
// Invoice data
}
}The billing.invoice.payment.succeeded webhook notifies you when a payment for an invoice has been successfully processed. The invoice status will be updated to "paid".
This webhook is triggered when an invoice's status or details are updated.
{
"type": "billing.invoice.updated",
"data": {
// Invoice data
}
}The billing.invoice.updated webhook notifies you when an invoice's status or details have been updated. Status changes can include transitions from "processing" to "payment_required" or "unpaid" to "paid".
This webhook is triggered when an event has been created.
{
"type": "event.created",
"data": {
"event_id": 597,
"event_ref": "Hm0Ee8Pj6Me8",
"event_title": "New event",
"event_mux": "eEjTrQJRYtryIXw61R8EWjKRrJPW3IfMfW3xRnrMj9Q",
"event_desc": "",
"event_created": "2025-04-27 20:25:13",
"event_date": "2025-04-28 22:25:08 +02:00",
"event_recurring": 0,
"event_status": "idle",
"event_embed_domain": null,
"event_user_ref": "client_actor",
"event_password": null,
"event_signup": [
{
"title": "Navn",
"type": "name"
},
{
"title": "Email",
"type": "email"
}
],
"event_signup_success_msg": "Thank you for signing up!",
"event_signup_form_msg": null,
"event_signup_required": false,
"event_qa": false,
"event_chat": false,
"event_client_ref": "g5zp39",
"event_image": null,
"event_mux_playback": "KuAf6pLkzqHYjmtbkB3eaTUG0100rhpyFwaZmJQL5zrHg",
"event_mux_asset": null,
"event_mux_asset_id": null,
"event_lang": "en",
"event_show_logo": true,
"event_qa_email_required": true,
"event_qa_form_text": null,
"event_show_countdown": true,
"event_custom_signup": false,
"event_test": "null",
"event_delivered_minutes": 0,
"event_delivered_minutes_archive": 0,
"event_mux_asset_replaced": 0,
"event_email_html": "<html> <head> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" \/> <meta http-equiv=\"Content-Type\" content=\"text\/html charset=UTF-8\" \/> <\/head> <body style=\"color: #fff; margin: 0 auto; padding: 0px 20px; padding-top: 40px; font-family: arial; text-align: center; max-width: 100%; background-color: #111;\"> \t<img src=\"https:\/\/beestreamed.com\/assets\/logo_white.png\" style=\"margin: 0 auto; width: 342px; height: 36px;\"\/> <div style=\"margin: 0 auto; padding-top: 40px; padding-bottom: 40px; max-width: 500px; text-align: center;\"> <p style=\"width: 100%; font-size: 16px; line-height: 24px; text-align: left; margin-bottom: 35px;\"> Hello [NAME], <br \/> <br \/> Thank you for signing up to our event! To watch it click the button below. <\/p> <a href=\"https:\/\/beestreamed.com\/event?id=[EVENT_REF]&signup=[SIGNUP_REF]\" style=\"color: #fff; padding: 15px 25px; border-radius: 5px; text-align: center; background-color: #EF9328; max-width: 150px; text-decoration: none; margin-top: 30px; font-size: 16px;\" > Watch event <\/a> <\/div> <div style=\"margin-top: auto; display: flex; gap: 10px; padding-bottom: 20px; padding-top: 60px; font-size: 14px; opacity: 0.75; width: 100%;\"> <a href=\"https:\/\/beestreamed.com\" target=\"_blank\" style=\"color: #bbb;\">Beestreamed<\/a> <a href=\"https:\/\/beestreamed.com\/privacy\" target=\"_blank\" style=\"color: #bbb; margin-left: 5px;\">Privacy policies<\/a> <a href=\"https:\/\/beestreamed.com\/tos\" target=\"_blank\" style=\"color: #bbb; margin-left: 5px;\">Terms of service<\/a> <\/div> <\/body> <\/html>",
"event_webrtc": true,
"event_email_title": "Beestreamed | Link to event",
"event_signup_auto_email": false,
"event_signup_terms_custom": null,
"event_sessions": 0,
"event_custom_player": false,
"event_video_ref": "",
"event_video_auto_switch": 1,
"event_save_stream_in_videos": 1,
"event_mux_is_live": 0,
"event_enabled": 1,
"event_legacy": 0,
"event_videosdk_room": "gfyc-s3fm-yum3",
"event_time_zone": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris",
"event_subtitles": 0,
"event_summary": null,
"event_summary_cooldown": 0,
"event_hidden": false,
"event_speaker_request": false,
"event_chat_form_text": null,
"event_signup_email": 1,
"event_advanced": false,
"event_redirect": false,
"event_redirect_url": null,
"event_signup_btn_text": null,
"event_date_unix": 1745871908,
"event_timezone": "Europe\/Berlin"
},
"id": "Fd3Ap2Ij5Gb1Jm2Kc2Fc6Oo7Nl4Ce0Jn_24d70ce16236c7f39ec32e70b2e8b495",
"timestamp": 1745785514
}The event.created webhook notifies you when an event has been created.
This webhook is triggered when an event has been deleted.
{
"type": "event.deleted",
"data": {
"event_ref": "Me5Fg4Lk4Ie5"
},
"id": "Il4Aa3Aj4Oe8Hg6Dm7Np4Hb2Le3Ja9Ka_cec2d7f6f083477fc8d7d9f11c3ddb60",
"timestamp": 1745784111
}The event.deleted webhook notifies you when an event has been deleted.
This webhook is triggered when an event's details are updated.
{
"type": "event.updated",
"data": {
"event_id": 597,
"event_ref": "Hm0Ee8Pj6Me8",
"event_title": "This is my mega cool event",
"event_mux": "eEjTrQJRYtryIXw61R8EWjKRrJPW3IfMfW3xRnrMj9Q",
"event_desc": "See my cool event for a cool presentation!",
"event_created": "2025-04-27 20:25:13",
"event_date": "2025-04-28 22:25:08 +02:00",
"event_recurring": 0,
"event_status": "idle",
"event_embed_domain": null,
"event_user_ref": "client_actor",
"event_password": null,
"event_signup": [
{
"title": "Navn",
"type": "name"
},
{
"title": "Email",
"type": "email"
}
],
"event_signup_success_msg": "Thank you for signing up!",
"event_signup_form_msg": null,
"event_signup_required": false,
"event_qa": false,
"event_chat": false,
"event_client_ref": "g5zp39",
"event_image": null,
"event_mux_playback": "KuAf6pLkzqHYjmtbkB3eaTUG0100rhpyFwaZmJQL5zrHg",
"event_mux_asset": null,
"event_mux_asset_id": null,
"event_lang": "en",
"event_show_logo": true,
"event_qa_email_required": true,
"event_qa_form_text": null,
"event_show_countdown": true,
"event_custom_signup": false,
"event_test": "null",
"event_delivered_minutes": 0,
"event_delivered_minutes_archive": 0,
"event_mux_asset_replaced": 0,
"event_email_html": "<html> <head> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" \/> <meta http-equiv=\"Content-Type\" content=\"text\/html charset=UTF-8\" \/> <\/head> <body style=\"color: #fff; margin: 0 auto; padding: 0px 20px; padding-top: 40px; font-family: arial; text-align: center; max-width: 100%; background-color: #111;\"> \t<img src=\"https:\/\/beestreamed.com\/assets\/logo_white.png\" style=\"margin: 0 auto; width: 342px; height: 36px;\"\/> <div style=\"margin: 0 auto; padding-top: 40px; padding-bottom: 40px; max-width: 500px; text-align: center;\"> <p style=\"width: 100%; font-size: 16px; line-height: 24px; text-align: left; margin-bottom: 35px;\"> Hello [NAME], <br \/> <br \/> Thank you for signing up to our event! To watch it click the button below. <\/p> <a href=\"https:\/\/beestreamed.com\/event?id=[EVENT_REF]&signup=[SIGNUP_REF]\" style=\"color: #fff; padding: 15px 25px; border-radius: 5px; text-align: center; background-color: #EF9328; max-width: 150px; text-decoration: none; margin-top: 30px; font-size: 16px;\" > Watch event <\/a> <\/div> <div style=\"margin-top: auto; display: flex; gap: 10px; padding-bottom: 20px; padding-top: 60px; font-size: 14px; opacity: 0.75; width: 100%;\"> <a href=\"https:\/\/beestreamed.com\" target=\"_blank\" style=\"color: #bbb;\">Beestreamed<\/a> <a href=\"https:\/\/beestreamed.com\/privacy\" target=\"_blank\" style=\"color: #bbb; margin-left: 5px;\">Privacy policies<\/a> <a href=\"https:\/\/beestreamed.com\/tos\" target=\"_blank\" style=\"color: #bbb; margin-left: 5px;\">Terms of service<\/a> <\/div> <\/body> <\/html>",
"event_webrtc": true,
"event_email_title": "Beestreamed | Link to event",
"event_signup_auto_email": false,
"event_signup_terms_custom": null,
"event_sessions": 0,
"event_custom_player": false,
"event_video_ref": "",
"event_video_auto_switch": 1,
"event_save_stream_in_videos": 1,
"event_mux_is_live": 0,
"event_enabled": 1,
"event_legacy": 0,
"event_videosdk_room": "gfyc-s3fm-yum3",
"event_time_zone": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris",
"event_subtitles": 0,
"event_summary": null,
"event_summary_cooldown": 0,
"event_hidden": false,
"event_speaker_request": false,
"event_chat_form_text": null,
"event_signup_email": 1,
"event_advanced": false,
"event_redirect": false,
"event_redirect_url": null,
"event_signup_btn_text": null,
"event_date_unix": 1745871908,
"event_timezone": "Europe\/Berlin"
},
"keys_updated": [
"event_title",
"event_desc"
],
"id": "Go5Nb4Kf8Ma0Bj8Kp9Ae0Kf5La0Bi3Jj_b9771f3ddcd538cc870ab643b5cd29ac",
"timestamp": 1745786551
}The event.updated webhook notifies you when any event details are changed. This includes modifications to metadata, schedule information, or other event properties.
This webhook is triggered when an event's status changes.
{
"type": "event.updated.status",
"data": {
"event_ref": "Hm0Ee8Pj6Me8",
"status": "idle"
},
"id": "Bf8Da0Gk1Mb6Ca4Bk0Ii3Ih9Lj9Ke3Ni_30c2ed9d0ba1986c9a3170e65460edf2",
"timestamp": 1745786454
}The event.updated.status webhook notifies you when an event's status changes. Status transitions can include changes like "scheduled" to "live", "live" to "ended", or other status changes in the event lifecycle.
This webhook is triggered when an event's stream key is disabled.
{
"type": "event.updated.streamkey.disabled",
"data": {
"event_ref": "Hm2Gb0Pf0Cn3"
},
"message": "Event stream key disabled",
"id": "Ja7Od6Kc6Jf3Lo5Kf6Ec0Mm1Eh9Ch8Jh_b8fbedbf39744c6f4e6f4ce0f6c66372",
"timestamp": 1745834155
}The event.updated.streamkey.disabled webhook notifies you when an event's stream key has been disabled. This may occur due to security violations, administrative actions, or other policy enforcement reasons.
This webhook is triggered when an event's stream key is reset.
{
"type": "event.updated.streamkey.reset",
"data": {
"event_ref": "Hm0Ee8Pj6Me8",
"key": "59f71f6b-3b8d-a98e-766f-21593f4f1c15",
"server": "rtmps://global-live.mux.com:443/app"
},
"message": "Event stream key reset",
"id": "Li0Of8He7Kh0Gp6Oc2Ng0Jo2Kj4Cf1Jd_0bfeb9516ace74027333bfd8fcee3850",
"timestamp": 1745786643
}The event.updated.streamkey.reset webhook notifies you when an event's stream key has been reset. This typically happens for security reasons or upon user request.
This webhook is triggered when a new poll is created.
{
"type": "poll.created",
"data": {
"poll_id": 150,
"poll_ref": "Hb4Oe5Gj",
"poll_event_ref": "Hm2Gb0Pf0Cn3",
"poll_data": {
"options": [
{
"option": "Yes",
"entries": 0
},
{
"option": "No",
"entries": 0
}
],
"question": "Did you find our webinar helpful?"
},
"poll_active": false,
"poll_archived": 0,
"poll_created": "2025-04-28 09:53:48",
"results_hidden": false
},
"id": "Ip8Aa8Na0Ob4Ab5Ig5Cf9Ag4Kk0Pe4Da_dbd208ee64fe2e8cf4e3b0bafe8ff7a0",
"timestamp": 1745834028
}The poll.created webhook notifies you when a new poll has been created for an event. The poll is initially created in an inactive state and will need to be activated before it can receive responses.
This webhook is triggered when a poll is deleted.
{
"type": "poll.deleted",
"data": {
"poll_ref": "Hb4Oe5Gj"
},
"id": "Hm1If4Hj2Oj5Hj4Bb2Eg2Dj7Jf5Bh4Ik_f645b2e9c5be307a303e1db7152a089c",
"timestamp": 1745834063
}The poll.deleted webhook notifies you when a poll has been deleted.
This webhook is triggered when a new signup entry is created for an event.
{
"type": "signup.created",
"data": {
"signup_ref": "Ck5Ao4Db2Kf5Aj9Kn1El4Pb2",
"signup_date": "2025-04-28 09:52:15",
"signup_data": {
"name": "John Doe",
"email": "john@doe.com"
},
"signup_email_sent": 0,
"signup_visited": 0,
"signup_date_visited": null,
"signup_mux_viewer_id": null
},
"id": "Fa0Kp1Eg9Ba3Ak4Bl3Km0Jn3Mm0Od1Jh_e0aabc97ff1d0e17b4a9f7e233eac3cf",
"timestamp": 1745833935
}The signup.created webhook notifies you when a new user has signed up for an event. This occurs when a user completes the signup form for an event.
This webhook is triggered when video delivery has been updated.
{
"type": "video.delivery.updated",
"data": {
"video_id": 848,
"video_ref": "Df4Me0Li0Kd4Mm8Ge5Jj3Ok3Di8Mi1Cp",
"video_mux_data": {
"details": {
"frame_rate": 30,
"resolution": "1080p",
"aspect_ratio": "16:9",
"resolution_tag": "HD"
},
"asset_id": "uM4lKBbtPhE2GiXeQUe7dT7q7SS9iyG02UEMV007bVdtI",
"duration": 34.933333,
"playback_id": "ILLNi3D7Bubdaa8pClZKgJANRaw3shWqdFKTxg00M5Rk"
},
"video_client_ref": "g5zp39",
"video_event_ref": null,
"video_date": "2025-04-28 09:16:38",
"video_title": "This is my cool video",
"video_mux_asset_id": "uM4lKBbtPhE2GiXeQUe7dT7q7SS9iyG02UEMV007bVdtI",
"video_mux_sync": 1,
"video_delivery_current": 1485,
"video_delivery_next_update": 1745918198,
"video_deleted": 0,
"video_delete_date": 0,
"video_delivery_paid": 0,
"video_temp": 0,
"video_delivery_last_update": 1745831798,
"video_public": 0,
"video_tags": {
"tags": [
"Fun",
"Explainer"
]
},
"video_description": null,
"video_total_views": 0,
"video_slug": null
},
"delivery": {
"new_delivery": 1485,
"added_delivery": 485,
"next_update": 1745877045,
"last_update": 1745790645,
"total_views": 23
},
"id": "Ha1Fc3Gn0Gc9Io2Jh3Oc0Eh0Io8Pk3Fa_b64acd67ebcd23c3e125adfbf8904823",
"timestamp": 1745833845
}The video.delivery.updated webhook notifies you when the delivery usage of a video has been updated.
This webhook is triggered when a video is created from an event
{
"type": "video.event.created",
"data": {
"video_id": 845,
"video_ref": "Kh6Mf9Kf3Ie5Ag2Da1Dp5Cn0Bh0Fo4Gb",
"video_mux_data": {
"asset_id": "ELpcQLFt7konzHAQe1D01QuJIA5m8bO8zgn9B9mQaVFQ",
"playback_id": "8h4vGamsmrhvieusQNLZ1V94CAhlaCWi48y8o015v6RY"
},
"video_client_ref": "g5zp39",
"video_event_ref": null,
"video_date": "2025-04-28 09:02:04",
"video_title": "my-video.mov",
"video_mux_asset_id": "ELpcQLFt7konzHAQe1D01QuJIA5m8bO8zgn9B9mQaVFQ",
"video_mux_sync": 0,
"video_delivery_current": 0,
"video_delivery_next_update": 1745917324,
"video_deleted": 0,
"video_delete_date": 0,
"video_delivery_paid": 0,
"video_temp": 1,
"video_delivery_last_update": null,
"video_public": 0,
"video_tags": {
"tags": []
},
"video_description": null,
"video_total_views": 0,
"video_slug": null
},
"id": "Ka0Gn8Hh1Af3Bk2Fj6Nn0Hh0Cn0Ni6Ca_a612a73e568a6fd78e0598639b25dcaf",
"timestamp": 1745830925
}The video.event.created webhook notifies you when a new video has been created from an event.
This webhook is triggered when video details have been updated.
{
"type": "video.updated",
"data": {
"video_id": 848,
"video_ref": "Df4Me0Li0Kd4Mm8Ge5Jj3Ok3Di8Mi1Cp",
"video_mux_data": {
"details": {
"frame_rate": 30,
"resolution": "1080p",
"aspect_ratio": "16:9",
"resolution_tag": "HD"
},
"asset_id": "uM4lKBbtPhE2GiXeQUe7dT7q7SS9iyG02UEMV007bVdtI",
"duration": 34.933333,
"playback_id": "ILLNi3D7Bubdaa8pClZKgJANRaw3shWqdFKTxg00M5Rk"
},
"video_client_ref": "g5zp39",
"video_event_ref": null,
"video_date": "2025-04-28 09:16:38",
"video_title": "This is my cool video",
"video_mux_asset_id": "uM4lKBbtPhE2GiXeQUe7dT7q7SS9iyG02UEMV007bVdtI",
"video_mux_sync": 1,
"video_delivery_current": 0,
"video_delivery_next_update": 1745918198,
"video_deleted": 0,
"video_delete_date": 0,
"video_delivery_paid": 0,
"video_temp": 0,
"video_delivery_last_update": 1745831798,
"video_public": 0,
"video_tags": {
"tags": [
"Fun",
"Explainer"
]
},
"video_description": null,
"video_total_views": 0,
"video_slug": null
},
"keys_updated": [
"video_title",
"video_tags"
],
"id": "Ha1Fc3Gn0Gc9Io2Jh3Oc0Eh0Io8Pk3Fa_b64acd67ebcd23c3e125adfbf8904823",
"timestamp": 1745833845
}The video.updated webhook notifies you when metadata or other details of a video have been updated. This can include changes to the title, description, thumbnail, tags, or other video attributes.
This webhook is triggered when a video is created from an upload.
{
"type": "video.upload.created",
"data": {
"video_id": 845,
"video_ref": "Kh6Mf9Kf3Ie5Ag2Da1Dp5Cn0Bh0Fo4Gb",
"video_mux_data": {
"asset_id": "ELpcQLFt7konzHAQe1D01QuJIA5m8bO8zgn9B9mQaVFQ",
"playback_id": "8h4vGamsmrhvieusQNLZ1V94CAhlaCWi48y8o015v6RY"
},
"video_client_ref": "g5zp39",
"video_event_ref": null,
"video_date": "2025-04-28 09:02:04",
"video_title": "my-video.mov",
"video_mux_asset_id": "ELpcQLFt7konzHAQe1D01QuJIA5m8bO8zgn9B9mQaVFQ",
"video_mux_sync": 0,
"video_delivery_current": 0,
"video_delivery_next_update": 1745917324,
"video_deleted": 0,
"video_delete_date": 0,
"video_delivery_paid": 0,
"video_temp": 1,
"video_delivery_last_update": null,
"video_public": 0,
"video_tags": {
"tags": []
},
"video_description": null,
"video_total_views": 0,
"video_slug": null
},
"id": "Ka0Gn8Hh1Af3Bk2Fj6Nn0Hh0Cn0Ni6Ca_a612a73e568a6fd78e0598639b25dcaf",
"timestamp": 1745830925
}The video.created.upload webhook notifies you when a video has been created from an upload.
This webhook is triggered when a video upload is done.
{
"type": "video.upload.done",
"data": {
"upload_id": 242,
"upload_ref": "Ik3Li5Nj4Cm0An7Ko1Eb3Mn8Ej3Ma1Do",
"upload_video_ref": null,
"upload_user_ref": "E0QRGZ",
"upload_client_ref": "g5zp39",
"upload_created": "2025-04-28 09:01:53",
"upload_mux_id": "02KRfJHPiEfDE8FoJT1Z2KuLJHx02A502r5hiKhcnzfmGY",
"upload_mux_expire_date": 1745834513,
"upload_status": "done",
"upload_title": "my-video.mov",
"upload_duration": 0
},
"id": "Oo4Dh2Bm0Pk1En4Ko0On3Kb1Pf1Kd9Hj_3a4d1af492848cf1608eaf5650031bd0",
"timestamp": 1745830924
}The video.upload.done webhook notifies you when a video upload has been completed successfully.
This webhook is triggered when a new video upload is initiated.
{
"type": "video.upload.new",
"data": {
"upload_ref": "Bb3Pn1Af8Pd0Ga8Nk6Je0Io1Hg2Mm2Cj",
"upload_title": "my-video.mov",
"upload_data": {
"id": "G101800ntH8KatkZq8Q9GZDdZbiW2LolNSNRrkyxpJitE",
"timeout": 3600,
"status": "waiting",
"new_asset_settings": {
"master_access": "none",
"mp4_support": "standard",
"normalize_audio": false
},
"cors_origin": "https://manage.beestreamed.com",
"url": "https://storage.googleapis.com/video-storage-gcp-us-east1-vop1-uploads/TgzsHGi5fj5jbg68uLNdKF?Expires=1745835388&GoogleAccessId=uploads-gcp-us-east1-vop1%40mux-video-production.iam.gserviceaccount.com&Signature=k0fRD5UjZU%2Fs8sCOPHqTM3AdJ9Wkl7a%2B%2BDb4HhyKhuBYat55s1fwDre%2BCBhcU%2BPWwyhTGzTQotj1KuciuOAx4RS0NZLt3beJycmbvqutbHA%2BP%2Bsdy808%2F%2FPuANV3mzgE7pPI10KHyXDqQ8U7qsqvb1MCLHbxShc57H8pLqlc19PKBKeBEgT7aOseYwW4xa3QBKMOZWL0fYLsn5K6x2406aq41D2j5D%2FY0YG3%2FMVH1lM2ceDJFdNuGQP%2BDCTqtMjxCEA68CV8ujkezcg7xPHfvOG6ahbyNpMvsiB%2B9gSBC%2Bg1pXSR0u1kFXiXOn4hlseaqMHBcQJTB0CSsMwZtMo%2BIw%3D%3D&upload_id=AAO2Vwrw4opX4zSBCGqN2L2JXlFLS1vo-VIGbSiIoU8lt2o52CQiJ6n1UgpKy_z-14t-9u8AMc0o9vbsoaBwZOW7W6h9ElkfMcrKFLN23RwtMA"
}
},
"id": "Oj4Ef4Kc3Nb4Cb8Eg8Mk5Ol2Jg3Ii3Ab_6a4a18409d0ce7ca9600ebddd2a72288",
"timestamp": 1745831788
}The video.upload.new webhook notifies you when a user starts uploading a new video to your platform. This is the initial notification before the upload process is completed.
This webhook is triggered when a video upload is in a pending state, typically waiting for processing.
{
"type": "video.upload.pending",
"data": {
"upload_ref": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
},
"id": "Ng0Lb1Dl3Gc8Ml4Jh4Ml2Pb1Ph3Ei1Fh_99642bebbf798375317ea0a56ae83787",
"timestamp": 1745786775
}The video.upload.pending webhook notifies you when a video upload has been received but is waiting in a queue for processing or requires additional actions before it can be completed.