From 704b83de8243751391302125610eb17febde4b56 Mon Sep 17 00:00:00 2001 From: Ali Iqbal Date: Mon, 18 May 2026 16:35:54 +0500 Subject: [PATCH 1/4] Update livestorm docs --- src/provider-guides/livestorm.mdx | 86 +++++++++++++++++++++++-------- 1 file changed, 65 insertions(+), 21 deletions(-) diff --git a/src/provider-guides/livestorm.mdx b/src/provider-guides/livestorm.mdx index 1527a42a..ca9120e1 100644 --- a/src/provider-guides/livestorm.mdx +++ b/src/provider-guides/livestorm.mdx @@ -1,39 +1,64 @@ --- title: "Livestorm" --- + ## What's supported ### Supported actions This connector supports: -- [Proxy Actions](/proxy-actions), using the base URL https://api.livestorm.co. -## Before You Get Started +- [Read Actions](/read-actions), including full historic backfill. Incremental read is supported for **`events`**. +- [Write Actions](/write-actions) (create and update where the Livestorm API allows; destructive operations such as removing an **event** are handled through Write where supported—there is no separate Delete action in the catalog). +- [Proxy Actions](/proxy-actions), using the base URL `https://api.livestorm.co`. + +### Supported objects + +export const Check = () => ✅ +export const Cross = () => 🚫 + +
+ + + + + + + + + + + + + + + + +
ObjectReadWriteSubscribe
events
people
people_attributes
session_chat_messages
users
+
+ +### Notes and limitations + +- **Write support**: `events` supports create and update; event removal is available where the API allows. `users` supports **create** only. Pass fields in `recordData`; the connector builds JSON:API `data` payloads unless you supply a full JSON:API document. Session bulk registrants (`POST …/sessions/{id}/people/bulk`) are not on Write—use Proxy or a future Bulk-style integration if needed. +- **Read behavior**: List endpoints use JSON:API (`data` as an array). `session_chat_messages` requires a **session id** in the read **filter**. Pagination uses `page[number]` / `page[size]`; next page may come from `meta.next_page` or from page counters on the prior response. `Fields` use flattened attributes for projection; **`raw`** keeps the nested JSON:API resource shape. + +### Example integration + +To define an integration for Livestorm, create a manifest file (`amp.yaml`). For a complete example, visit our [samples repo on GitHub](https://github.com/amp-labs/samples). -To integrate Livestorm with Ampersand, you must register a Livestorm OAuth2 application. To do this, contact [help@livestorm.co](mailto:help@livestorm.co) and provide the following details: +## Before you get started + +To integrate Livestorm with Ampersand, you must register a Livestorm OAuth2 application. Contact [help@livestorm.co](mailto:help@livestorm.co) and provide the following details: - **Redirect URL**: Please provide a unique HTTPS redirect URL for your app. **Note** that dynamic URLs are not supported at this time. -- **App Logo**: Provide logo for your app. The image should be square with a maximum size of 500px x 500px. +- **App logo**: Provide logo for your app. The image should be square with a maximum size of 500px x 500px. - **Scope**: Specify the scope required for your app to function. Once your application is registered, you will receive two credentials: **client_id** and **client_secret.** These credentials are required to connect Livestorm with Ampersand. -### Example integration - -To define an integration for livestorm, create a manifest file that looks like this: +Livestorm’s API uses [JSON:API](https://developers.livestorm.co/docs/requests-and-responses) at **`https://api.livestorm.co`**. For development, [API token authentication](https://developers.livestorm.co/docs/api-token-authentication) is also available from **Account Settings → Integrations → Public API** in Livestorm. -```YAML -#amp.yaml -specVersion: 1.0.0 -integrations: - - name: livestormIntegration - displayName: Livestorm - provider: livestorm - proxy: - enabled: true -``` - -## Add Your Livestorm App Info to Ampersand +## Add your Livestorm app info to Ampersand 1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com). @@ -41,10 +66,29 @@ integrations: ![Ampersand Project Selection](/images/provider-guides/31a6a12-Ampersand.png) -3. Select **Provider Apps**. +3. Select **Provider Apps**. 4. Select Livestorm from the **Provider** list. 5. Enter the previously obtained Client ID in the **Client ID** field, the Client Secret in the **Client Secret** field and scopes in the **Scopes** field. - ![Ampersand Integration](/images/provider-guides/livestorm.gif) \ No newline at end of file + ![Ampersand Integration](/images/provider-guides/livestorm.gif) + +## Using the connector + +This connector uses **OAuth2 Authorization Code** grant type, so you must configure a **Provider App** before getting started. + +To start integrating with Livestorm: + +- Create a manifest file; see [Example integration](#example-integration). +- Deploy it using the [amp CLI](/cli/overview). +- If you are using Read Actions, create a [destination](/destinations). +- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component so customers authorize Livestorm. +- Start using the connector: + - If your integration has [Read Actions](/read-actions), you'll start getting webhook messages. + - If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API. + - If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls. + + +For **`session_chat_messages`**, each read must target a session—the connector expects a session id in the read **filter**. + From 859145e6e309519d12b4528988fa09aa068fec4c Mon Sep 17 00:00:00 2001 From: Ali Iqbal Date: Mon, 18 May 2026 17:23:49 +0500 Subject: [PATCH 2/4] Update sample link --- src/provider-guides/livestorm.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/provider-guides/livestorm.mdx b/src/provider-guides/livestorm.mdx index ca9120e1..7e985215 100644 --- a/src/provider-guides/livestorm.mdx +++ b/src/provider-guides/livestorm.mdx @@ -44,7 +44,7 @@ export const Cross = () => 🚫 ### Example integration -To define an integration for Livestorm, create a manifest file (`amp.yaml`). For a complete example, visit our [samples repo on GitHub](https://github.com/amp-labs/samples). +To define an integration for Livestorm, create a manifest file (`amp.yaml`). For a complete example, visit our [samples repo on GitHub](https://github.com/amp-labs/samples/blob/main/livestorm/amp.yaml). ## Before you get started From 6dc22eca9bdd5319b772ffff8fa38e90b484051a Mon Sep 17 00:00:00 2001 From: Ali Iqbal Date: Wed, 20 May 2026 17:14:39 +0500 Subject: [PATCH 3/4] Fix PR comments --- src/provider-guides/livestorm.mdx | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/src/provider-guides/livestorm.mdx b/src/provider-guides/livestorm.mdx index 7e985215..d43d7674 100644 --- a/src/provider-guides/livestorm.mdx +++ b/src/provider-guides/livestorm.mdx @@ -9,7 +9,7 @@ title: "Livestorm" This connector supports: - [Read Actions](/read-actions), including full historic backfill. Incremental read is supported for **`events`**. -- [Write Actions](/write-actions) (create and update where the Livestorm API allows; destructive operations such as removing an **event** are handled through Write where supported—there is no separate Delete action in the catalog). +- [Write Actions](/write-actions). - [Proxy Actions](/proxy-actions), using the base URL `https://api.livestorm.co`. ### Supported objects @@ -31,24 +31,18 @@ export const Cross = () => 🚫 events people people_attributes - session_chat_messages users -### Notes and limitations - -- **Write support**: `events` supports create and update; event removal is available where the API allows. `users` supports **create** only. Pass fields in `recordData`; the connector builds JSON:API `data` payloads unless you supply a full JSON:API document. Session bulk registrants (`POST …/sessions/{id}/people/bulk`) are not on Write—use Proxy or a future Bulk-style integration if needed. -- **Read behavior**: List endpoints use JSON:API (`data` as an array). `session_chat_messages` requires a **session id** in the read **filter**. Pagination uses `page[number]` / `page[size]`; next page may come from `meta.next_page` or from page counters on the prior response. `Fields` use flattened attributes for projection; **`raw`** keeps the nested JSON:API resource shape. - ### Example integration -To define an integration for Livestorm, create a manifest file (`amp.yaml`). For a complete example, visit our [samples repo on GitHub](https://github.com/amp-labs/samples/blob/main/livestorm/amp.yaml). +For an example manifest file of a Livestorm integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/livestorm/amp.yaml). ## Before you get started -To integrate Livestorm with Ampersand, you must register a Livestorm OAuth2 application. Contact [help@livestorm.co](mailto:help@livestorm.co) and provide the following details: +To integrate Livestorm with Ampersand using OAuth, you must register a Livestorm OAuth2 application. Contact [help@livestorm.co](mailto:help@livestorm.co) and provide the following details: - **Redirect URL**: Please provide a unique HTTPS redirect URL for your app. **Note** that dynamic URLs are not supported at this time. - **App logo**: Provide logo for your app. The image should be square with a maximum size of 500px x 500px. @@ -56,8 +50,6 @@ To integrate Livestorm with Ampersand, you must register a Livestorm OAuth2 appl Once your application is registered, you will receive two credentials: **client_id** and **client_secret.** These credentials are required to connect Livestorm with Ampersand. -Livestorm’s API uses [JSON:API](https://developers.livestorm.co/docs/requests-and-responses) at **`https://api.livestorm.co`**. For development, [API token authentication](https://developers.livestorm.co/docs/api-token-authentication) is also available from **Account Settings → Integrations → Public API** in Livestorm. - ## Add your Livestorm app info to Ampersand 1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com). @@ -76,11 +68,11 @@ Livestorm’s API uses [JSON:API](https://developers.livestorm.co/docs/requests- ## Using the connector -This connector uses **OAuth2 Authorization Code** grant type, so you must configure a **Provider App** before getting started. +This connector uses **OAuth2 Authorization Code** grant type, so you must configure a **Provider App** before getting started. (Provider Apps are only required for providers using the **OAuth2 Authorization Code grant type**.) To start integrating with Livestorm: -- Create a manifest file; see [Example integration](#example-integration). +- Create a manifest file using the [example](https://github.com/amp-labs/samples/blob/main/livestorm/amp.yaml). - Deploy it using the [amp CLI](/cli/overview). - If you are using Read Actions, create a [destination](/destinations). - Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component so customers authorize Livestorm. @@ -89,6 +81,12 @@ To start integrating with Livestorm: - If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API. - If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls. - -For **`session_chat_messages`**, each read must target a session—the connector expects a session id in the read **filter**. - +## Creating an API key for Livestorm + +For development and testing, you can use [API token authentication](https://developers.livestorm.co/docs/api-token-authentication) instead of OAuth. The [InstallIntegration](/embeddable-ui-components#install-integration) UI component can prompt customers for an API key when your integration uses API Key auth. + +1. Log in to your [Livestorm account](https://app.livestorm.co). +2. Go to **Account Settings** → **Integrations**. +3. Scroll to **Public API** and open the card. +4. Generate a new API token and choose the scopes your integration needs (for example, **events** for read/write on events and participants, **admin** for **users**). +5. Copy the token when it is shown—it is only displayed once. From 6b39b32c10563684828efe40285ada45f254a276 Mon Sep 17 00:00:00 2001 From: Ali Iqbal Date: Tue, 26 May 2026 11:50:55 +0500 Subject: [PATCH 4/4] Rm Oauth2 comment --- src/provider-guides/livestorm.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/provider-guides/livestorm.mdx b/src/provider-guides/livestorm.mdx index d43d7674..762000cf 100644 --- a/src/provider-guides/livestorm.mdx +++ b/src/provider-guides/livestorm.mdx @@ -83,8 +83,6 @@ To start integrating with Livestorm: ## Creating an API key for Livestorm -For development and testing, you can use [API token authentication](https://developers.livestorm.co/docs/api-token-authentication) instead of OAuth. The [InstallIntegration](/embeddable-ui-components#install-integration) UI component can prompt customers for an API key when your integration uses API Key auth. - 1. Log in to your [Livestorm account](https://app.livestorm.co). 2. Go to **Account Settings** → **Integrations**. 3. Scroll to **Public API** and open the card.