Livestorm

App · 25 actions

Manage webinar events, sessions, registrations and engagement in Livestorm.

Actions

ActionWhat it does
Create eventCreate an event.
Create sessionCreate an event session.
Create webhookCreate a webhook.
Delete eventDelete an event.
Delete sessionDelete a session.
Delete webhookDelete a webhook.
Get eventGet an event.
Get organizationGet current organization.
Get personGet a person.
Get sessionGet a Session.
List chat messagesList the chat messages from a session.
List event peopleList the people from an event.
List event sessionsList event sessions.
List eventsList events.
List peopleList people.
List people attributesList people_attributes.
List questionsList the questions from a session.
List recordingsList the recordings from a session.
List session peopleList the people from a session.
List sessionsList Sessions.
List webhooksList webhooks.
Register personRegister someone for a session.
Remove personRemove someone from a session.
Update eventPartially update an event.
Update sessionPartially update a session.

Create event

Create an event.

Inputs

Copy from event IDcopy_from_event_idtext
Copy from event id.
Owner IDowner_idtext
Owner id.
TitletitletextRequired
Title.
Slugslugtext
Slug.
Statusstatustext
Status.
Everyone can speakeveryone_can_speaktrue/false
Everyone can speak.
Detailed registration page enableddetailed_registration_page_enabledtrue/false
Detailed registration page enabled.
Light registration page enabledlight_registration_page_enabledtrue/false
Light registration page enabled.
Descriptiondescriptiontext
Description.
Recording enabledrecording_enabledtrue/false
Recording enabled.
Recording publicrecording_publictrue/false
Recording public.
Show in company pageshow_in_company_pagetrue/false
Show in company page.
Chat enabledchat_enabledtrue/false
Chat enabled.
Questions enabledquestions_enabledtrue/false
Questions enabled.
Polls enabledpolls_enabledtrue/false
Polls enabled.
Relationships sessionsrelationships_sessionslist
Relationships sessions.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "chat_enabled": false,
        "created_at": 1,
        "description": "example",
        "detailed_registration_page_enabled": false,
        "estimated_duration": 1,
        "everyone_can_speak": false,
        "fields": [],
        "language": "example",
        "light_registration_page_enabled": false,
        "owner": {},
        "polls_enabled": false,
        "published_at": 1,
        "questions_enabled": false,
        "recording_enabled": false,
        "recording_public": false,
        "registration_link": "example",
        "registration_page_enabled": false,
        "sessions_count": 1,
        "show_in_company_page": false,
        "slug": "example",
        "status": "example",
        "title": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

Create session

Create an event session.

Inputs

IdidtextRequired
Event ID
Estimated started atestimated_started_atdate and time
Estimated started at.
Timezonetimezonetext
Time zone for this session. Dates are converted to this zone; defaults to UTC.One of: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa (Africa/addis ababa), Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, and 589 more.
Namenametext
Name.
Relationships peoplerelationships_peoplelist
Relationships people.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "attendees_count": 1,
        "canceled_at": 1,
        "created_at": 1,
        "duration": 1,
        "ended_at": 1,
        "estimated_started_at": 1,
        "event_type_id": "example",
        "name": "example",
        "registrants_count": 1,
        "room_link": "example",
        "started_at": 1,
        "status": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

Create webhook

Create a webhook.

Inputs

UrlurltextRequired
Url.
EventeventtextRequired
Event.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "created_at": 1,
        "event": "example",
        "updated_at": 1,
        "url": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}

Delete event

Delete an event.

Inputs

IdidtextRequired
Event ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete session

Delete a session.

Inputs

IdidtextRequired
Session ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete webhook

Delete a webhook.

Inputs

IdidtextRequired
Webhook ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Get event

Get an event.

Inputs

IdidtextRequired
Event ID
Includeincludelist
Include Related DataOne or more of: tags.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "chat_enabled": false,
        "created_at": 1,
        "description": "example",
        "detailed_registration_page_enabled": false,
        "estimated_duration": 1,
        "everyone_can_speak": false,
        "fields": [],
        "language": "example",
        "light_registration_page_enabled": false,
        "owner": {},
        "polls_enabled": false,
        "published_at": 1,
        "questions_enabled": false,
        "recording_enabled": false,
        "recording_public": false,
        "registration_link": "example",
        "registration_page_enabled": false,
        "sessions_count": 1,
        "show_in_company_page": false,
        "slug": "example",
        "status": "example",
        "title": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

Get organization

Get current organization.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "name": "example",
        "parent_id": "example",
        "slug": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}

Get person

Get a person.

Inputs

PersonidtextRequired
People ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "avatar_link": "example",
        "created_at": 1,
        "email": "example",
        "first_name": "example",
        "last_name": "example",
        "role": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

Get session

Get a Session.

Inputs

IdidtextRequired
Session ID
Includeincludelist
Include Related DataOne or more of: event, people, chat_messages (Chat messages), questions, recordings.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "attendees_count": 1,
        "canceled_at": 1,
        "created_at": 1,
        "duration": 1,
        "ended_at": 1,
        "estimated_started_at": 1,
        "event_type_id": "example",
        "name": "example",
        "registrants_count": 1,
        "room_link": "example",
        "started_at": 1,
        "status": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

List chat messages

List the chat messages from a session.

Inputs

IdidtextRequired
Session ID
Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Includeincludelist
Include Related DataOne or more of: people.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List event people

List the people from an event.

Inputs

IdidtextRequired
Event ID
Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Filter rolefilter_roletext
Filter People by role : 'participant', 'team_member'One of: team_member (Team member), participant.
Filter emailfilter_emailtext
Filter People by their email (exact match)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List event sessions

List event sessions.

Inputs

IdidtextRequired
Event ID
Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Filter statusfilter_statustext
Filter Sessions by status : 'upcoming', 'live', 'on_demand', 'past', 'past_not_started', 'canceled', 'draft'One of: upcoming, live, on_demand (On demand), past, past_not_started (Past not started), canceled, draft.
Filter date fromfilter_date_fromdate and time
Filter Sessions which ‘estimated_started_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter date tofilter_date_todate and time
Filter Sessions which ‘estimated_started_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter created sincefilter_created_sincedate and time
Filter Sessions which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter created untilfilter_created_untildate and time
Filter Sessions which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated sincefilter_updated_sincedate and time
Filter Sessions which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated untilfilter_updated_untildate and time
Filter Sessions which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter include breakout roomsfilter_include_breakout_roomstext
Filter Sessions depending upon if they are breakout room sessions or not
Includeincludelist
Include Related DataOne or more of: event, people.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List events

List events.

Inputs

Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Filter titlefilter_titletext
Filter Events by title
Filter everyone can speakfilter_everyone_can_speaktrue/false
Filter Events by everyone_can_speak
Filter scheduling statusfilter_scheduling_statustext
Filter Events by scheduling_status (live, upcoming, on_demand, ended, not_started, draft, cancelled, not_scheduled)One of: live, upcoming, on_demand (On demand), ended, not_started (Not started), draft, cancelled, not_scheduled (Not scheduled).
Filter created sincefilter_created_sincedate and time
Filter Events which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter created untilfilter_created_untildate and time
Filter Events which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated sincefilter_updated_sincedate and time
Filter Events which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated untilfilter_updated_untildate and time
Filter Events which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter tagfilter_tagtext
Filter Events by tag title (case-insensitive, comma-separated for multiple tags)
Includeincludelist
Include Related DataOne or more of: sessions, tags.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List people

List people.

Inputs

Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Filter rolefilter_roletext
Filter People by role : 'participant', 'team_member'One of: team_member (Team member), participant.
Filter emailfilter_emailtext
Filter People by their email (exact match)

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List people attributes

List people_attributes.

Inputs

Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Sortsorttext
Sortable Fields: (-)slug, name, placeholder, created_at, updated_at
Filter builtinfilter_builtintext
Filter PeopleAttributes by builtin
Filter descriptionfilter_descriptiontext
Filter PeopleAttributes by description
Filter namefilter_nametext
Filter PeopleAttributes by name
Filter placeholderfilter_placeholdertext
Filter PeopleAttributes by placeholder
Filter slugfilter_slugtext
Filter PeopleAttributes by slug
Filter typefilter_typetext
Filter PeopleAttributes by type (text, email, avatar, url, consent, unique_select, multiple_select)
Filter user IDfilter_user_idtext
Filter PeopleAttributes by user_id

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List questions

List the questions from a session.

Inputs

IdidtextRequired
Session ID
Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Includeincludelist
Include Related DataOne or more of: asker, responder.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List recordings

List the recordings from a session.

Inputs

IdidtextRequired
Session ID
Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Url expires in secondsurl_expires_in_secondstext
Time before URL link expires. Accepts values between 3600 and 604800 seconds (1 hour to 7 days), and default to 12 hours if not used

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List session people

List the people from a session.

Inputs

IdidtextRequired
Session ID
Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Filter rolefilter_roletext
Filter People by role : 'participant', 'team_member'One of: team_member (Team member), participant.
Filter attendedfilter_attendedtrue/false
Filter People that attend or not the Session
Filter emailfilter_emailtext
Filter People by their email (exact match)
Filter created sincefilter_created_sincedate and time
Filter People which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter created untilfilter_created_untildate and time
Filter People which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated sincefilter_updated_sincedate and time
Filter People which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated untilfilter_updated_untildate and time
Filter People which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Includeincludelist
Include Related DataOne or more of: event, session.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List sessions

List Sessions.

Inputs

Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Filter statusfilter_statustext
Filter Sessions by status : 'upcoming', 'live', 'on_demand', 'past', 'past_not_started', 'canceled', 'draft'One of: upcoming, live, on_demand (On demand), past, past_not_started (Past not started), canceled, draft.
Filter date fromfilter_date_fromdate and time
Filter Sessions which ‘estimated_started_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter date tofilter_date_todate and time
Filter Sessions which ‘estimated_started_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter created sincefilter_created_sincedate and time
Filter Sessions which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter created untilfilter_created_untildate and time
Filter Sessions which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated sincefilter_updated_sincedate and time
Filter Sessions which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter updated untilfilter_updated_untildate and time
Filter Sessions which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
Filter include breakout roomsfilter_include_breakout_roomstext
Filter Sessions depending upon if they are breakout room sessions or not

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}

List webhooks

List webhooks.

Inputs

Page numberpage_numbernumber
Page index to be returnedFrom 1 to 1000000.
Page sizepage_sizenumber
Number of record to be returned by pageFrom 1 to 100.
Filter eventfilter_eventtext
Filter Webhooks by event : event.published, event.created, session.started, session.ended, session.created, people.registered, people.attended, people.not_attended, people.watched_replay, job.ended

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "meta": {}
  }
}

Register person

Register someone for a session.

Inputs

IdidtextRequired
Session ID
Referrerreferrertext
Referrer.
Utm sourceutm_sourcetext
Utm source.
Utm mediumutm_mediumtext
Utm medium.
Utm termutm_termtext
Utm term.
Utm contentutm_contenttext
Utm content.
Utm campaignutm_campaigntext
Utm campaign.
EmailemailtextRequired
Email address of the person to register.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "avatar_link": "example",
        "created_at": 1,
        "email": "example",
        "first_name": "example",
        "last_name": "example",
        "registrant_detail": {},
        "role": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

Remove person

Remove someone from a session.

Inputs

IdidtextRequired
Session ID
Registered personpeople_idtextRequired
People ID

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Update event

Partially update an event.

Inputs

IdidtextRequired
Event ID
Owner IDowner_idtext
Owner id.
Titletitletext
Title.
Slugslugtext
Slug.
Statusstatustext
Status.
Everyone can speakeveryone_can_speaktrue/false
Everyone can speak.
Detailed registration page enableddetailed_registration_page_enabledtrue/false
Detailed registration page enabled.
Light registration page enabledlight_registration_page_enabledtrue/false
Light registration page enabled.
Descriptiondescriptiontext
Description.
Recording enabledrecording_enabledtrue/false
Recording enabled.
Recording publicrecording_publictrue/false
Recording public.
Show in company pageshow_in_company_pagetrue/false
Show in company page.
Chat enabledchat_enabledtrue/false
Chat enabled.
Questions enabledquestions_enabledtrue/false
Questions enabled.
Polls enabledpolls_enabledtrue/false
Polls enabled.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "chat_enabled": false,
        "created_at": 1,
        "description": "example",
        "detailed_registration_page_enabled": false,
        "estimated_duration": 1,
        "everyone_can_speak": false,
        "fields": [],
        "language": "example",
        "light_registration_page_enabled": false,
        "owner": {},
        "polls_enabled": false,
        "published_at": 1,
        "questions_enabled": false,
        "recording_enabled": false,
        "recording_public": false,
        "registration_link": "example",
        "registration_page_enabled": false,
        "sessions_count": 1,
        "show_in_company_page": false,
        "slug": "example",
        "status": "example",
        "title": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

Update session

Partially update a session.

Inputs

IdidtextRequired
Session ID
Estimated started atestimated_started_atdate and time
Estimated started at.
Timezonetimezonetext
Time zone for this session. Dates are converted to this zone; defaults to UTC.One of: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa (Africa/addis ababa), Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, and 589 more.
Namenametext
Name.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "attendees_count": 1,
        "canceled_at": 1,
        "created_at": 1,
        "duration": 1,
        "ended_at": 1,
        "estimated_started_at": 1,
        "event_type_id": "example",
        "name": "example",
        "registrants_count": 1,
        "room_link": "example",
        "started_at": 1,
        "status": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

On this page