Webinar API documentation.

How do I make my first API call?

Replace $FLAXXA_KEY with a key from your workspace. The first call returns a real id you can use for the next ones.

# 1. Create an evergreen (automated) webinar — returns a draft
curl -X POST https://flaxxa.com/api/v1/webinar/webinars \
  -H "Authorization: Bearer flx_live_YOUR_KEY" \
  -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{ "title": "Scaling with Flaxxa", "mode": "automated", "timezone": "Asia/Kolkata" }'

# 2. Set its premiere time, duration and just-in-time offset
curl -X PUT https://flaxxa.com/api/v1/webinar/webinars/42/schedule \
  -H "Authorization: Bearer flx_live_YOUR_KEY" \
  -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{ "starts_at": "2026-11-10T18:00", "duration_minutes": 45, "jit_offset_minutes": 5 }'

# 3. Read the audience and the live funnel
curl "https://flaxxa.com/api/v1/webinar/registrants?webinar_id=42&status=registered" \
  -H "Authorization: Bearer flx_live_YOUR_KEY" -H "Accept: application/json"

$webinar = Http::withToken(env('FLAXXA_WEBINAR_KEY'))->acceptJson()
    ->post('https://flaxxa.com/api/v1/webinar/webinars', [
        'title'    => "{$course->name} — live cohort",
        'mode'     => 'live',
        'timezone' => $tenant->timezone,
    ])->throw()->json('data');   // $webinar['id'], ['slug'], ['status']

$course->update(['flaxxa_webinar_id' => $webinar['id']]);

import requests
r = requests.post("https://flaxxa.com/api/v1/webinar/webinars",
    headers={"Authorization": f"Bearer {KEY}", "Accept": "application/json"},
    json={"title": "Scaling with Flaxxa", "mode": "automated", "timezone": "Asia/Kolkata"})
r.raise_for_status()
webinar = r.json()["data"]
print(webinar["id"], webinar["status"])  # -> 42 draft

POST /api/v1/webinar/webinars HTTP/1.1
Host: flaxxa.com
Authorization: Bearer flx_live_·············
Content-Type: application/json

{
  "title":    "Scaling with Flaxxa — October masterclass",
  "mode":     "automated",
  "timezone": "Asia/Kolkata"
}

HTTP/1.1 201 Created
Content-Type: application/json

{
  "data": {
    "id": 42, "slug": "scaling-with-flaxxa-october-masterclass",
    "title": "Scaling with Flaxxa — October masterclass",
    "mode": "automated", "status": "draft",
    "timezone": "Asia/Kolkata", "is_paid": false,
    "created_at": "2026-10-28T10:00:00+00:00"
  }
}

How do I authenticate?

Every call requires Authorization: Bearer <key>. Rotate from workspace settings — old keys are revoked instantly. Server-side only; never ship a live key to the browser.

Webinars API

Create a webinar in any mode — `live`, `automated` (evergreen as-if-live), `jit` (just-in-time), `on_demand`, `hybrid` or `series` — then configure and publish it. A new webinar starts as a `draft`.

Sessions & schedule API

Live / hybrid / series webinars materialise one or more sessions; evergreen modes spawn a per-registrant session at sign-up. Set the premiere time and the just-in-time start offset here.

Registrants API

Your audience. People register on the public page (fires app.webinar.registrant.registered); you can also import, export and run GDPR operations.

Engagement & Q&A API

Review and answer questions across every session, and moderate a live session's chat and Q&A as host.

Polls, CTAs & handouts API

Host-defined interactions, timed by playback offset for evergreen viewers or pushed live during a broadcast.

Analytics API

Read-only funnel, drop-off and live dashboards. Analytics is core (not entitlement-gated).

Commerce, growth & surveys API

Paid-webinar pricing and orders, affiliates and short links, and surveys / quizzes.

Live broadcasting API

Drive a live or hybrid broadcast: readiness, go live, recording and RTMP simulcast. Live minutes, attendees per session and simulcast follow your plan.

Meetings API

Interactive rooms where everyone can talk. Participants join at /m/{code}.

Webhooks API

POST /api/v1/webhooks { url, subscribed_events[] } — deliveries carry X-Flaxxa-Event and X-Flaxxa-Signature (HMAC-SHA256 of the raw body with your endpoint secret).

Which webhook events can I subscribe to?

Subscribe via POST /webhooks. Verify X-Flaxxa-Signature on every payload.

• app.webinar.webinar.created

  A webinar was created (as a draft).

• app.webinar.webinar.published

  A webinar left draft — scheduled or live.

• app.webinar.webinar.updated

  A webinar's details changed.

• app.webinar.registrant.registered

  Someone registered on the public registration page.

• app.webinar.session.started

  A live / premiere session went on air.

• app.webinar.session.ended

  A session ended (its recording finalizes shortly after).

What errors can the API return?

All errors return a JSON envelope: { error: { code, message, details } }. Retry idempotent calls on 5xx with exponential backoff.

Which rules apply to every request?

Every Flaxxa app's API follows the same authentication, rate limits, idempotency and webhook signing.