Back

Livestorm API Essential Guide

Aug 15, 20246 minute read

What type of API does Livestorm provide?

Based on the search results, Livestorm provides a REST API. The API documentation explicitly states that Livestorm provides a "REST API". The API enables various use cases such as registering participants from custom registration pages or forms, creating custom reports for events, synchronizing contact details with CRM systems, registering multiple participants at once from databases, and storing event engagement data in data warehouses. To use the Livestorm API, developers need to generate an API token from their dashboard and can then access the developer portal for detailed guides and references. The API is designed to be flexible and allow for integration with internal systems, back offices, and third-party applications.

Does the Livestorm API have webhooks?

Yes, the official Livestorm API does have webhooks. Here are the key points about Livestorm's webhooks:

Webhook Availability

Livestorm provides webhooks that allow you to subscribe to real-time event notifications that occur in your Livestorm account.

Types of Events You Can Subscribe To

You can subscribe to the following types of webhook events:

  1. event.created - Triggered when a new event is created
  2. event.published - Triggered when an event is published
  3. Event starts - Notifies when an event begins
  4. Event ends - Notifies when an event concludes
  5. New registrant - Sends registrant data when someone registers

Key Points to Consider

  • Webhooks work by sending POST requests with JSON data to a URL you specify.
  • When you subscribe to a webhook event, it will apply to all sessions/events in your workspace. You cannot select specific sessions for webhook notifications.
  • Livestorm provides both a native Webhooks integration and a REST API for managing webhooks.
  • The webhook payloads include detailed information about the event, such as title, registration link, start time, end time, attendee data, etc.

Use Cases

Some common use cases for Livestorm webhooks include:

  • Syncing registrant data with your CRM
  • Sending custom email notifications when an event is published
  • Gathering webinar data in your analytics software
  • Automating workflows based on event start/end

Best Practices

  • Ensure your endpoint can handle the webhook payload and process it reliably.
  • Implement proper security measures to validate incoming webhook requests.
  • Consider using the REST API for more advanced webhook management if needed.

By utilizing Livestorm's webhooks, you can create powerful integrations and automate various processes related to your virtual events and webinars.

Rate Limits and other limitations

The Livestorm API has the following rate limits:

Monthly Rate Limit

  • 10,000 API calls per 30-day period [1][2]
  • This 30-day period starts from the first request made [2]
  • The limit resets after 30 days [2]

Burst Rate Limit

  • 5 requests per second [2]

Key Points

  • The monthly rate limit can be increased by purchasing an add-on (for Business and Enterprise plans only) [1][2]

  • The burst rate limit cannot be changed [2]

  • When the rate limit is exceeded:

    • Requests will be rejected with an HTTP 429 response code [1][2]
    • You'll need to wait before making new requests [1][2]
  • Rate limit information is provided in response headers:

    • RateLimit-Monthly-Limit
    • RateLimit-Interval-Limit
    • RateLimit-Monthly-Remaining
    • RateLimit-Interval-Remaining
    • Retry-After
    • RateLimit-Reset [2]

Best Practices

  • Monitor your API usage in the API panel [1]
  • Implement throttling or retry strategies to avoid hitting limits [5]
  • Use the Retry-After and RateLimit-Reset headers to determine when to retry requests [1][2]
  • Subscribe to the developer newsletter to stay informed about API changes [4]

By understanding and working within these rate limits, developers can effectively use the Livestorm API while avoiding disruptions due to exceeding quotas.

Latest API Version

Based on the search results provided, I don't have specific information about the most recent version of the Livestorm API. The search results don't mention any version numbers or recent updates to the API version.

However, I can provide some key information about the Livestorm API based on the search results:

Key Points

  • Livestorm offers a REST API that allows developers to programmatically manage organization data and automate processes.

  • The API enables various use cases like registering participants, creating custom reports, synchronizing contact details, and more.

  • Livestorm has a rate limit of 10,000 API calls per 30-day period.

  • Only workspace owners and admins can access and generate API tokens.

  • Livestorm provides webhooks in addition to the REST API to listen for events on your account.

Recent Updates

While there's no specific version mentioned, some recent updates to the API include:

  • A new GET /sessions/{id}/recordings endpoint was added about 2 years ago to retrieve recordings of event sessions.

  • A new GET /sessions/{id}/questions endpoint was added about 2 years ago to retrieve questions asked during event sessions.

  • A new GET /sessions/{id}/chat_messages endpoint was added over 2 years ago to retrieve chat messages from event sessions.

  • An improvement was made about 2 years ago to make email the only required field when registering someone through the API.

Best Practices

  • Developers should subscribe to Livestorm's developer-specific newsletter to stay updated on API changes and deprecations.

  • Monitor API usage and rate limits through the API panel in account settings.

  • If you need to increase the monthly API rate limit, you can purchase an add-on (for Business and Enterprise plans).

To get the most up-to-date information on the Livestorm API version and features, it would be best to check Livestorm's official developer documentation or contact their support team directly.

How to get a Livestorm developer account and API Keys?

1. Contact Livestorm Support

  • You need to contact Livestorm's customer support at [email protected] to request API access for your account.
  • Only validated workspaces can use the API, so support will need to enable API access for your specific account.

2. Generate an API Token

Once API access is enabled for your account:

  1. Log in to your Livestorm dashboard
  2. Go to Account Settings > Integrations
  3. Scroll down to the "Public API" card
  4. Click to generate a new API token

Important notes:

  • Only workspace owners and admins can generate API tokens
  • The token will only be shown once, so save it securely

3. Set Token Scopes

When generating a token, you'll need to set the permission scopes:

  • Identity - access to /me and /organization endpoints
  • Events - access to events, sessions, participants endpoints
  • Admin - access to team member and organization endpoints
  • Webhooks - access to webhook-related endpoints

Choose the appropriate scopes needed for your integration.

4. Use the Token

You can now use the token in the Authorization header when making API requests:

curl --request GET \
     --url https://api.livestorm.co/v1/ping \
     --header 'Accept: application/json' \
     --header 'Authorization: YOUR_API_TOKEN'

What can you do with the Livestorm API?

Based on the provided search results, here's a list of data models you can interact with using the Livestorm API, along with what is possible for each data model:

Events

  • Create new events
  • Retrieve a single event
  • List all events
  • Customize event settings

People/Registrants

  • Register participants from external sources
  • List all attendees linked to event sessions
  • Add new registrants
  • Track registrant attendance status

Attendance

  • Retrieve attendance information
  • Track who attended webinars
  • Track who did not attend webinars

Engagement Data

  • Access and retrieve engagement data
  • Send engagement data to external tools (e.g., BI tools, CRM)

Sessions

  • Manage event sessions
  • Track session-specific data

Contact Information

  • Synchronize contact details with external systems
  • Manage and update participant information

Reporting

  • Create custom reports for past events
  • Access event analytics and metrics

Webhooks

  • Set up webhooks to listen for specific events in your Livestorm account

API Usage

  • Monitor API call usage and rate limits
  • Manage API tokens

Integrations

  • Build custom integrations with other applications
  • Automate processes between Livestorm and external platforms

Key Points to Consider:

  • The Livestorm API follows REST principles
  • API usage is limited to 10,000 calls per 30-day period
  • Only workspace owners and admins can access and generate API tokens
  • The API allows for automation of various processes, including participant registration, data synchronization, and custom reporting
  • Livestorm provides documentation and a developer portal for detailed API information

By leveraging these data models and functionalities, developers can create powerful integrations and automate various aspects of event management using the Livestorm API.