Authentication

How to authenticate your API requests and get secure access to all resources

Livestorm’s REST API provides 2 authentication methods: private API tokens and OAuth2. The API token authentication method is available to all Livestorm customers who want to build private apps, automate processes, and retrieving engagement data. The OAuth2 authentication method is only available for technology partners who want to build public integrations with Livestorm.

API token authentication

Generating an API token

In order to use our public 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:

Generate API token videoGenerate API token video

Generate API token video

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 tokens won't change anything. If this happens, contact our support.

🚧

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! Be careful not to leak this API token anywhere unsafe, where people could get access to it (for instance a public frontend application).

Using your API token

Once you've generated your API token, simply pass it in the Authorization header for each API request. Here's an example:

curl 'https://api.livestorm.co/v1/ping' \
  -H 'authorization: YOUR_API_TOKEN'

A simple way to test your API token is to call our /ping endpoint. If you receive a 200 HTTP status code, you're good to go!

OAuth2 authentication

Technology partners willing to build publicly-listed integrations with Livestorm can register for OAuth2 credentials.
Join the Technology Partner Program here →

📘

Private apps cannot benefit from the OAuth2 flow yet. If you're interested in the OAuth2 feature for private use only, submit a feature request here.


Did this page help you?