API token authentication

Validate your account

🚧

The API can only be used by validated workspaces

If you want to get access to the API for your Livestorm account, please contact our customer support service at [email protected]. They’ll be able to open the API access to your account.

Generate an API token

In order to use Livestorm’s REST API, you need to generate an API token. To do so, navigate to the 'Account Settings' > 'Integrations' page and scroll down to the bottom of the page. Click on the 'Public API' card and you'll be able to generate your own API tokens:

How to generate an API tokenHow to generate an API token

How to generate an API token

🚧

When you create an API token, it will only be shown once for security reasons. So don't forget to save it somewhere safe for later!

Choose the scopes of your token

For security reasons, Livestorm will require you to choose the scope permissions related to your freshly created API tokens. This ensures that your token can only trigger authorized actions or get access to specific data.

Each scope permission can be set to none (no access at all), read (simple read access), or write (full read and write access).

Here are the scope entities that can be configured for your new API tokens:

  • Identity: The identity scope includes access to the /me and /organization endpoints.
  • Events: The events scope gives you access to all endpoints related to events, sessions, and participants (e.g /events[/*], /sessions[/*], /people/[/*]).
  • Admin: The admin scope gives you access to endpoints related to teams members (e.g /users[/*]) and to the /organization endpoint.
  • Webhooks: The webhooks scope gives you access to all webhooks-related endpoints (e.g /webhooks[/*]).

📘

When creating your API tokens, don’t forget to choose the token scopes that your client app will need to work properly. Otherwise, your API calls will result in a 401 unauthorized error! But don’t worry, you’ll still be able to edit your token’s scopes down the road.

Use the API token

Finally, you can now call the API with your API token filled in the Authorization header:

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

If you receive an HTTP 200 successful status, your token works! Check our detailed API reference to learn about our endpoints.

Note about rate limits

One thing to notice is that your API rate limits will be shared among all your organization's API tokens. It means that if you've reached your monthly quota or quota per second, creating a new API token won't change anything. If this happens, contact our support.


Did this page help you?