Livestorm
App · 25 actions
Manage webinar events, sessions, registrations and engagement in Livestorm.
Actions
| Action | What it does |
|---|---|
| Create event | Create an event. |
| Create session | Create an event session. |
| Create webhook | Create a webhook. |
| Delete event | Delete an event. |
| Delete session | Delete a session. |
| Delete webhook | Delete a webhook. |
| Get event | Get an event. |
| Get organization | Get current organization. |
| Get person | Get a person. |
| Get session | Get a Session. |
| List chat messages | List the chat messages from a session. |
| List event people | List the people from an event. |
| List event sessions | List event sessions. |
| List events | List events. |
| List people | List people. |
| List people attributes | List people_attributes. |
| List questions | List the questions from a session. |
| List recordings | List the recordings from a session. |
| List session people | List the people from a session. |
| List sessions | List Sessions. |
| List webhooks | List webhooks. |
| Register person | Register someone for a session. |
| Remove person | Remove someone from a session. |
| Update event | Partially update an event. |
| Update session | Partially update a session. |
Create event
Create an event.
Inputs
- Copy from event ID
copy_from_event_idtext - Copy from event id.
- Owner ID
owner_idtext - Owner id.
- Title
titletextRequired - Title.
- Slug
slugtext - Slug.
- Status
statustext - Status.
- Everyone can speak
everyone_can_speaktrue/false - Everyone can speak.
- Detailed registration page enabled
detailed_registration_page_enabledtrue/false - Detailed registration page enabled.
- Light registration page enabled
light_registration_page_enabledtrue/false - Light registration page enabled.
- Description
descriptiontext - Description.
- Recording enabled
recording_enabledtrue/false - Recording enabled.
- Recording public
recording_publictrue/false - Recording public.
- Show in company page
show_in_company_pagetrue/false - Show in company page.
- Chat enabled
chat_enabledtrue/false - Chat enabled.
- Questions enabled
questions_enabledtrue/false - Questions enabled.
- Polls enabled
polls_enabledtrue/false - Polls enabled.
- Relationships sessions
relationships_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
- Id
idtextRequired - Event ID
- Estimated started at
estimated_started_atdate and time - Estimated started at.
- Timezone
timezonetext - 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. - Name
nametext - Name.
- Relationships people
relationships_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
- Url
urltextRequired - Url.
- Event
eventtextRequired - 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
- Id
idtextRequired - Event ID
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Delete session
Delete a session.
Inputs
- Id
idtextRequired - Session ID
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Delete webhook
Delete a webhook.
Inputs
- Id
idtextRequired - Webhook ID
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Get event
Get an event.
Inputs
- Id
idtextRequired - Event ID
- Include
includelist - 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
- Person
idtextRequired - 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
- Id
idtextRequired - Session ID
- Include
includelist - 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
- Id
idtextRequired - Session ID
- Page number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Include
includelist - 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
- Id
idtextRequired - Event ID
- Page number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Filter role
filter_roletext - Filter People by role : 'participant', 'team_member'One of:
team_member(Team member),participant. - Filter email
filter_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
- Id
idtextRequired - Event ID
- Page number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Filter status
filter_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 from
filter_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 to
filter_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 since
filter_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 until
filter_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 since
filter_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 until
filter_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 rooms
filter_include_breakout_roomstext - Filter Sessions depending upon if they are breakout room sessions or not
- Include
includelist - 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 number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Filter title
filter_titletext - Filter Events by title
- Filter everyone can speak
filter_everyone_can_speaktrue/false - Filter Events by everyone_can_speak
- Filter scheduling status
filter_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 since
filter_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 until
filter_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 since
filter_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 until
filter_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 tag
filter_tagtext - Filter Events by tag title (case-insensitive, comma-separated for multiple tags)
- Include
includelist - 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 number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Filter role
filter_roletext - Filter People by role : 'participant', 'team_member'One of:
team_member(Team member),participant. - Filter email
filter_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 number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Sort
sorttext - Sortable Fields: (-)slug, name, placeholder, created_at, updated_at
- Filter builtin
filter_builtintext - Filter PeopleAttributes by builtin
- Filter description
filter_descriptiontext - Filter PeopleAttributes by description
- Filter name
filter_nametext - Filter PeopleAttributes by name
- Filter placeholder
filter_placeholdertext - Filter PeopleAttributes by placeholder
- Filter slug
filter_slugtext - Filter PeopleAttributes by slug
- Filter type
filter_typetext - Filter PeopleAttributes by type (text, email, avatar, url, consent, unique_select, multiple_select)
- Filter user ID
filter_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
- Id
idtextRequired - Session ID
- Page number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Include
includelist - 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
- Id
idtextRequired - Session ID
- Page number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Url expires in seconds
url_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
- Id
idtextRequired - Session ID
- Page number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Filter role
filter_roletext - Filter People by role : 'participant', 'team_member'One of:
team_member(Team member),participant. - Filter attended
filter_attendedtrue/false - Filter People that attend or not the Session
- Filter email
filter_emailtext - Filter People by their email (exact match)
- Filter created since
filter_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 until
filter_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 since
filter_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 until
filter_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).
- Include
includelist - 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 number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Filter status
filter_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 from
filter_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 to
filter_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 since
filter_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 until
filter_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 since
filter_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 until
filter_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 rooms
filter_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 number
page_numbernumber - Page index to be returnedFrom 1 to 1000000.
- Page size
page_sizenumber - Number of record to be returned by pageFrom 1 to 100.
- Filter event
filter_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
- Id
idtextRequired - Session ID
- Referrer
referrertext - Referrer.
- Utm source
utm_sourcetext - Utm source.
- Utm medium
utm_mediumtext - Utm medium.
- Utm term
utm_termtext - Utm term.
- Utm content
utm_contenttext - Utm content.
- Utm campaign
utm_campaigntext - Utm campaign.
- Email
emailtextRequired - Email address of the person to register.
- First name
first_nametext - First name.
- Last name
last_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
- Id
idtextRequired - Session ID
- Registered person
people_idtextRequired - People ID
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Update event
Partially update an event.
Inputs
- Id
idtextRequired - Event ID
- Owner ID
owner_idtext - Owner id.
- Title
titletext - Title.
- Slug
slugtext - Slug.
- Status
statustext - Status.
- Everyone can speak
everyone_can_speaktrue/false - Everyone can speak.
- Detailed registration page enabled
detailed_registration_page_enabledtrue/false - Detailed registration page enabled.
- Light registration page enabled
light_registration_page_enabledtrue/false - Light registration page enabled.
- Description
descriptiontext - Description.
- Recording enabled
recording_enabledtrue/false - Recording enabled.
- Recording public
recording_publictrue/false - Recording public.
- Show in company page
show_in_company_pagetrue/false - Show in company page.
- Chat enabled
chat_enabledtrue/false - Chat enabled.
- Questions enabled
questions_enabledtrue/false - Questions enabled.
- Polls enabled
polls_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
- Id
idtextRequired - Session ID
- Estimated started at
estimated_started_atdate and time - Estimated started at.
- Timezone
timezonetext - 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. - Name
nametext - 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"
}
}
}