Overview
Event webhooks allow you to have your Cloud Video platform notify an external app about a particular Live Event in real time. When a live event is starting soon or goes live, your platform sends an HTTP POST request to a configured URL. Enabling integration automation tools, social media posting, custom systems, and more.
Event Types
Three webhook events are dispatched for live events:
- starting_soon Fired before the scheduled start time. Useful for promotional posts, audience reminders, or pre-event automation.
- started Fired when a live event goes live. Ideal for real-time posts, audience notifications, or “now streaming” automations.
- ended Fired when the live event concludes. Can be used to archive content, notify subscribers, or trigger post-event workflows.
Configuring the Webhook URL
- Navigate to Brand Settings in the side menu
- Locate the Webhook URL field
- Enter the HTTPS endpoint that should receive event payloads
- Click Save
Integration Example — Integrately
One option for using the Event Webhok feature is Integrately. Integrately can receive webhook payloads and trigger downstream actions such as posting to Facebook, Slack, or sending emails. These steps will allow you to have an event announcement posted to Facebook before and during an event.
- Create a new automation in Integrately and select Webhook as the trigger.
- Copy the generated Integrately webhook URL.
- Paste it into the Webhook URL field in Brand Settings.
- Add a Facebook: Create Post action using fields from the webhook payload (e.g. event.title, event.public_page_url).
- Trigger event by scheduling a live event.
- A post should now appear on Facebook before and at the event start time.
Payload
All event webhooks send an HTTP POST request with a JSON body. The payload contains two top-level objects: customer and event.
Example payload (starting_soon):
{ "event_type": "starting_soon", "event": { "title": "Weekly Livestream Q&A", "category": "Education", "summary": "Join us for this week's live Q&A session.", "start_datetime": "2026-05-01T10:00:00", "end_datetime": "2026-05-01T11:00:00", "timezone": "Australia/Sydney", "customer_name_override": "The A-Team Show", "custom_event_url": "https://example.com/live", "public_page_url": "https://platform.example.com/events/weekly-qa" }, "customer": { "name": "Acme Broadcasting", "email": "[email protected]" } }Customer object fields:
- name – The customer account’s registered name
- email – The customer account’s primary email address
Event object fields:
- title – The title of the live event
- category – Event category as configured
- summary – Short description or summary of the event
- start_datetime – Scheduled start date and time (ISO 8601, localised to event timezone)
- end_datetime – Scheduled end date and time (ISO 8601, localised to event timezone)
- timezone – IANA timezone name the event times are relative to (e.g. Australia/Sydney)
- customer_name_override – Optional display name override for the customer on the public page
- custom_event_url – Alternative URL used in place of the public page URL if set
- public_page_url – Full URL to the event’s public page on the platform