Understanding the Live Events Endpoint in the LightcastAPI
Overview
The Live Events Endpoint in the LightcastAPI allows developers to retrieve, create, update, and delete Live Broadcast Events for Live Events Channels programmatically.
This makes it possible to integrate Live Event scheduling and event information with websites, apps, and other custom workflows.
When to use the Live Events Endpoint
Use the Live Events Endpoint when you want to manage Live Broadcast Events through the LightcastAPI instead of managing each event manually in the Media Cloud.
This may be helpful when:
You want to display current or upcoming Live Broadcast Events on a website or app
You want to create Live Broadcast Events from a custom scheduling workflow
You want to update event details programmatically
You want to remove events that are no longer needed
You are building a custom integration that depends on Live Event scheduling data
The Live Events Endpoint is intended for developers and technical teams using the LightcastAPI.
How it works
The Live Events Endpoint provides API actions for managing individual Live Broadcast Events on Live Events Channels.
Developers can use the endpoint to retrieve event information, create new events, update existing events, or delete current or upcoming events.
The available actions are:
Action | Purpose |
|---|---|
Get Events | Retrieve a list of current or upcoming Live Broadcast Events for a Live Events Channel |
Create Event | Create a new Live Broadcast Event on a Live Events Channel |
Update Event | Update supported details for an existing Live Broadcast Event on a Live Events Channel |
Delete Event | Delete a current or upcoming Live Broadcast Event from a Live Events Channel |
For full technical details, available parameters, and implementation instructions, see the Live Events Endpoint documentation.
Available actions
Get Events
Use Get Events to retrieve a list of current or upcoming Live Broadcast Events for a Live Events Channel.
This may be useful when you want to display event information on:
Websites
Apps
Custom event pages
Internal dashboards
Other connected experiences
Create Event
Use Create Event to create a new Live Broadcast Event on a Live Events Channel.
This may be useful when events are scheduled in an external system and need to be created automatically in the Media Cloud.
Update Event
Use Update Event to modify supported details for an existing Live Broadcast Event without manually editing the event in the Media Cloud.
Supported event updates include:
Title
Description
Start time
End time
Refer to the API documentation for required date, time, and timezone formats when creating or updating events.
Delete Event
Use Delete Event to remove a current or upcoming Live Broadcast Event that is no longer needed.
Compatibility notes
The Live Events Endpoint is designed for individual Live Broadcast Events.
Create Event, Update Event, and Delete Event are not compatible with:
Simulated Live Events
Recurring Weekly Event Groups
Social Media Restreams
The compatibility note above applies specifically to Create Event, Update Event, and Delete Event. For details about how Get Events returns event records, review the Live Events Endpoint documentation.
If your Live Event uses one of these features, manage the event directly in the Media Cloud or contact Customer Support for guidance.
Getting started
Step 1
Confirm that your account has access to the LightcastAPI.
Step 2
Review the Live Events Endpoint documentation.
The documentation includes technical details, available actions, and implementation instructions.
Step 3
Identify the Live Event Channel and event workflow you want to manage through the API.
Step 4
Choose the action that matches your workflow:
Use Get Events to retrieve current or upcoming events
Use Create Event to create a new Live Broadcast Event
Use Update Event to change supported details for an existing event
Use Delete Event to remove a current or upcoming event
Step 5
Test your API implementation with a non-production or test event before using it for a production Live Event.
FAQs
What is the Live Events Endpoint?
The Live Events Endpoint is part of the LightcastAPI. It allows developers to retrieve, create, update, and delete Live Broadcast Events programmatically.
What can I use the Live Events Endpoint for?
You can use the Live Events Endpoint to connect Live Event scheduling workflows with websites, apps, dashboards, and other custom workflows.
For example, developers can retrieve upcoming events for display on a website or create new Live Broadcast Events from an external scheduling workflow.
Can I retrieve upcoming Live Broadcast Events through the API?
Yes. The Get Events action can retrieve a list of current or upcoming Live Broadcast Events for a Live Events Channel.
Can I create Live Broadcast Events through the API?
Yes. The Create Event action can create a new Live Broadcast Event on a Live Events Channel.
Can I update an existing Live Broadcast Event through the API?
Yes. The Update Event action can update supported details for an existing Live Broadcast Event.
Supported updates include the event title, description, start time, and end time.
Can I delete a Live Broadcast Event through the API?
Yes. The Delete Event action can delete a current or upcoming Live Broadcast Event when the event is no longer needed.
Does the Live Events Endpoint support Simulated Live Events?
Create Event, Update Event, and Delete Event do not support Simulated Live Events.
If you need to manage a Simulated Live Event, manage the event directly in the Media Cloud or contact Customer Support for guidance.
Does the Live Events Endpoint support recurring weekly event groups?
Create Event, Update Event, and Delete Event do not support Recurring Weekly Event Groups.
If you need to manage a recurring event group, manage the event directly in the Media Cloud or contact Customer Support for guidance.
Does the Live Events Endpoint support Social Media Restreams?
Create Event, Update Event, and Delete Event do not support Social Media Restreams.
If you need to manage an event with Social Media Restreams, manage the event directly in the Media Cloud or contact Customer Support for guidance.
Where can developers find the technical documentation?
Developers can review the Live Events Endpoint documentation for technical details, available actions, and implementation instructions.
Pricing
LightcastAPI is available on POWER packages and up.
If you don't have access to this feature, you can upgrade to one of our latest plans or contact your account manager.
