For the complete documentation index, see llms.txt. This page is also available as Markdown.

External API

Use Storylane's External API to connect your workspace with internal tools, applications, and automated workflows.

The API is available to users on all paid plans. If you need help, contact us at support@storylane.io.

With the API, you can:

  • List and publish demos, and retrieve their content and engagement stats

  • List workspace hubs

  • Create and manage demo and hub links, including passcodes, expiration dates, and other access controls

  • Create email tokens for demo and hub links

  • Retrieve demo sessions and demo hub sessions, along with aggregate stats for both

  • List and retrieve lead accounts and leads

Getting started

You can generate and manage API keys directly from your Storylane workspace.

Step 1: Generate an API key

  1. Sign in to your Storylane workspace.

  2. Go to Settings → Integrations.

  3. Find API keys and click View key.

  4. Copy the Workspace ID displayed in the modal.

  5. Click Generate new key to create an API key.

  6. Give the key a descriptive name, such as Production automation, Analytics sync, or Staging.

  7. Copy the generated API key and store it securely.

We recommend creating a separate API key for each integration or environment. This makes it easier to rotate or revoke access without affecting your other integrations.

Step 2: Configure the Postman collection

Open the Storylane Public Postman Collection.

In the collection variables, replace:

  • ACCESS_TOKEN with the API key you generated in Storylane. It will be used as the Bearer authentication token.

  • WORKSPACE_ID with your Storylane workspace ID, if required by the endpoint.

Then save the updated variables.

Step 3: Test the connection

Run the API endpoints in Postman and verify that you are successfully retrieving your company’s demo data.

Here is an interactive demo demonstrating how to set up using Postman 👇

spinner

A successful response will return data from your Storylane workspace. If the request fails, verify that:

  • The API key was copied correctly

  • The key is active

  • The request uses Bearer authentication

  • The workspace ID is correct, where required

  • Your workspace has access to the External API

Managing API keys

You can return to Settings → Integrations → API keys at any time to view active keys or revoke keys that are no longer needed.

To rotate a key safely:

  1. Generate a new API key.

  2. Update your integration to use the new key.

  3. Confirm that the integration is working.

  4. Revoke the old key.

If you believe a key has been exposed, generate a replacement and revoke the affected key immediately.

API Responses

1. All Workspace Demos

GET /api/connect/v1/workspaces/:workspace_id/demos Use the endpoint to list all demos in your workspace. A sample response:

2. Get Details on a Single Demo

GET /api/connect/v1/workspaces/:workspace_id/demos/:id Use the endpoint to fetch detailed information about a specific demo. A sample response:

3. Publish a Demo

POST /api/connect/v1/workspaces/:workspace_id/demos/:id/publish Use the endpoint to publish a demo. A sample response:

4. Paginated Stats for All Workspace Demos

GET /api/connect/v1/workspaces/:workspace_id/demos/stats Use the endpoint to fetch paginated engagement stats across all workspace demos. A sample response:

5. All Demo Sessions

GET /api/connect/v1/workspaces/:workspace_id/demo_sessions Use the endpoint to list demo sessions across the workspace. A sample response:

6. Demo Sessions Stats

GET /api/connect/v1/workspaces/:workspace_id/demo_sessions/stats Use the endpoint to fetch aggregate demo session stats. A sample response:

7. Get Detailed Demo Session

GET /api/connect/v1/workspaces/:workspace_id/demo_sessions/:id Use the endpoint to fetch detailed information about a specific demo session. A sample response:

GET /api/connect/v1/workspaces/:workspace_id/demos/:demo_id/links Use the endpoint to list all links for a given demo. A sample response:

POST /api/connect/v1/workspaces/:workspace_id/demos/:demo_id/links Use the endpoint to create a new link for a demo. A sample response:

PATCH /api/connect/v1/workspaces/:workspace_id/demos/:demo_id/links/:id Use the endpoint to update an existing demo link. A sample response:

DELETE /api/connect/v1/workspaces/:workspace_id/demos/:demo_id/links/:id Use the endpoint to deactivate an existing demo link. Returns a 204 No Content response with no body on success.

POST /api/connect/v1/workspaces/:workspace_id/demos/:demo_id/links/:link_id/tokens Use the endpoint to create a new email token for a demo link. A sample response:

13. All Workspace Hubs

GET /api/connect/v1/workspaces/:workspace_id/hubs Use the endpoint to list all hubs in your workspace. A sample response:

GET /api/connect/v1/workspaces/:workspace_id/hubs/:hub_id/links Use the endpoint to list all links for a given hub. A sample response:

POST /api/connect/v1/workspaces/:workspace_id/hubs/:hub_id/links Use the endpoint to create a new link for a hub. A sample response:

PATCH /api/connect/v1/workspaces/:workspace_id/hubs/:hub_id/links/:id Use the endpoint to update an existing hub link. A sample response:

DELETE /api/connect/v1/workspaces/:workspace_id/hubs/:hub_id/links/:id Use the endpoint to deactivate an existing hub link. Returns a 204 No Content response with no body on success.

POST /api/connect/v1/workspaces/:workspace_id/hubs/:hub_id/links/:link_id/tokens Use the endpoint to create a new email token for a hub link. A sample response:

19. Get All Demo Sessions for a Hub

GET /api/connect/v1/workspaces/:workspace_id/hubs/:hub_id/demo_sessions Use the endpoint to list all demo sessions for a given hub. A sample response:

20. Get Detailed Demo Session for a Hub

GET /api/connect/v1/workspaces/:workspace_id/hubs/:hub_id/demo_sessions/:id Use the endpoint to fetch detailed information about a specific hub demo session. A sample response:

21. All Workspace Lead Accounts

GET /api/connect/v1/workspaces/:workspace_id/accounts Use the endpoint to list all lead accounts in your workspace. A sample response:

22. Get a Single Lead Account

GET /api/connect/v1/workspaces/:workspace_id/accounts/:id Use the endpoint to fetch a single lead account. A sample response:

23. All Workspace Leads

GET /api/connect/v1/workspaces/:workspace_id/leads Use the endpoint to list all leads in your workspace. A sample response:

Additional Notes

  • Ensure API tokens are stored securely and not shared publicly.

  • All list endpoints follow the same pagination shape where applicable: page, per_page, next_page.

For further assistance, please contact support@storylane.io.

Last updated

Was this helpful?