Resources
Learn which resources can be accessed through Livestorm's REST API
The API involves the main following resources: Events, Sessions, People, Users, and Webhooks. Let's take a look at each one of them
Event
It is a virtual event (either live or pre-recorded) that is hosted on Livestorm. It can be an online event/webinar, a masterclass, a live stream, a scheduled meeting, a customer or prospect call, etc. It contains all high-level information of the event such as its title, its registration form's fields, estimated duration, etc.
Session
Each Event object has a one-to-many relationship with its Sessions. Indeed, Sessions are instances of a single Event, and can represent the same event occurring multiple times at a given frequency (for instance with a weekly product demo), or multiple parts of the same Event (for instance with multiple talks of a day-long conference). For meetings, the structure would usually follow a 1 event → 1 session relationship.
Sessions objects contain the details about its estimated starting date, the timezone in which it will take place, etc.
People
Represents the registrants, guest speakers, or team members of a Livestorm account. People can be linked to an Event or an Event session. This object contains all the person's details such as their email, first name, and last name.
Essentially, an Event can have multiple Sessions, which can welcome multiple People (external registrants and eventually attendees, but also internal hosts and moderators):
User
The User object corresponds to a team member of your Livestorm workspace, who can either have a host
or moderator
role. Only host
users can start and stop event sessions.
Webhook
Finally, you can also programmatically manage webhooks from our API. You'll be able to choose which event subscription to listen for and specify your custom URL upon which Livestorm's API will post these events. Learn more about webhooks here →.
Updated over 2 years ago