Livestorm¶
The Livestorm modules enable you to monitor webinars or registrants, and search for and retrieve people or events in your Livestorm account.
Note
The Livestorm APIs are available only to paid subscription users.
Getting Started with Livestorm¶
Prerequisites
- A Livestorm account — you can create one at app.livestorm.co/#/signup.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Livestorm to Ibexa Connect¶
To connect your Livestorm account to Ibexa Connect, you'll need to obtain an API Key from your Livestorm account's settings.
-
Log in to your Livestorm account.
-
Click on your profile icon in the bottom-left corner, and open Account settings.
-
Navigate to Integrations > Public API.
-
Click the Generate a token button.
-
Enter the name for the token, click Generate a token, and copy the provided token*.*
-
Go to Ibexa Connect and open the Livestorm module's Create a connection dialog.
-
Enter the token you have copied in step 5 in the API Key field, and click the Continue button to establish the connection.
The connection has been established. You can proceed with setting up the module.
Webinars/Events¶
Watch Webinars Start¶
Triggers when a webinar starts.
| Webhook name | Enter the name for the webhook. E.g., Webinar started |
Watch Webinars Published¶
Triggers when a webinar is published.
| Webhook name | Enter the name for the webhook. E.g., Webinar published |
Watch Webinars End¶
Triggers when a webinar ends.
| Webhook name | Enter the name for the webhook. E.g., Webinar published |
Search Events¶
Retrieves events based on filter settings.
| Filter by Kind | Select whether to return webinars or meets. |
| Filter by Title | Enter the search term to filter results by the title. |
| Limit | Set the maximum number of events Ibexa Connect will return during one execution cycle. |
People¶
Watch New Registrants¶
Triggers when a person registers for the webinar.
| Webhook name | Enter the name for the webhook. E.g., New Registrant |
Search People¶
Retrieves participants or members based on filter settings.
| Event ID | Select the event or map the ID of the event that contains the session you want to retrieve participants for. |
| Session ID | Select the session or map the ID of the session you want to retrieve participants for. |
| Filter by Role | Select the role you want to filter returned people by. |
| Attended | Select Yes to list only people who have attended the session or No to list only those who haven't. |
| Filter by Email | Enter the email address of the person you want to retrieve details for. |
| Include | Select the object whose data you want to include in the module's output. |
| Limit | Set the maximum number of people Ibexa Connect will return during one execution cycle. |
Get a Person¶
Retrieves details of the specified person.
| Event ID | Select the event or map the ID of the event that contains the session you want to retrieve participant details from. |
| Session ID | Select the session or map the ID of the session you want to retrieve participant details from. |
| Person ID | Select the person or map the ID of the person you want to retrieve details for. |
Create a Registrant¶
Registers a participant to a session.
| Event ID | Select the event or map the ID of the event that contains the session you want to create a participant for. |
| Session ID | Select the session or map the ID of the session you want to register a participant for. |
| First Name | Enter the registrant's first name. |
| Last Name | Enter the registrant's last name. |
| Enter the registrant's email address. | |
| Referrer | Enter the referrer to specify where the registration request originated. |
| UTM parameters | Enter tracking parameters. |
Make an API Call¶
Allows you to perform a custom API call.
URL |
Enter a path relative to | For the list of available endpoints, please refer to the Livestorm API Documentation. |
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we've already added these for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Events¶
The following API call returns all events in your Livestorm account:
URL:
/v1/events
Method:
GET
 |
The result can be found in the module's Output under Bundle > Body > data.
In our example, 2 events were returned:
 |