THEOlive REST API
THEOlive provides a REST API to manage channels, receive events, create reports, and set up webhooks.
Alternatively, you can perform the most common actions directly from the THEOlive management console. See our getting started guide for more information.
Channel API
🗃️ Channels
7 items
🗃️ Channel Status
1 item
🗃️ Channel Aliases
7 items
🗃️ Analytics
1 item
🗃️ Events
2 items
🗃️ Security
13 items
Events API
📄️ Get event
Gets a specific event
📄️ Get events
Gets a list of events that happened in your organization. Think about channels created, started, stopped, webhooks enabled or disabled, ...
Reports API
📄️ Create report
📄️ Get reports
📄️ Update report
As long as a report is not generated, the values can be updated
📄️ Delete report
📄️ Get report
Schedulers API
📄️ Create scheduler
Define when a list of channels should be started
📄️ Get schedulers
Get the list of schedulers that are connected to your organization. The result set is limited to 100 schedulers. Schedulers are sorted by creation date, oldest ones first. You can navigate between multiple pages by using the `startingAfter` query parameter. When passing a scheduler ID here, results will be returned starting after this specific scheduler.
📄️ Get scheduler
Get a specific scheduler
📄️ Delete scheduler
Removes a scheduler. This action can't be done when a scheduler is active, only when it's pending or terminated
📄️ Update scheduler
Edit an existing scheduler object
📄️ Get scheduler report
Get the usage report of a terminated scheduler
📄️ Terminate scheduler
Terminate a scheduler manually
📄️ Start scheduler now
Start a scheduler manually and immeditaly
Webhooks API
📄️ Enable webhook
Enable a webhook and start receiving data
📄️ Disable webhook
Disable a webhook to stop receiving data
📄️ Update webhook
Update an existing webhook
📄️ Get webhook
Get one specific webhook
📄️ Delete webhook
Delete one specific webhook
📄️ Create webhook
Create a webhook to receive real-time updates
📄️ Get webhooks
Get list of all webhooks