Skip to main content

How to create your workspace API token

Learn how you can create your workspace API token.

Written by Tamás Párványik

Contents:

Overview: What is StoriesOnBoard API

The StoriesOnBoard API lets your backend integrate with StoriesOnBoard over HTTPS. It is a server-to-server API: calls are authenticated with a workspace API token and must be made from your own server, never from browser or mobile client code.

Capabilities

You can now send Insights (feedback) into StoriesOnBoard straight from your own systems — your product, your support tool, or a data pipeline — through a new server-side API.

A POST /api/v1/insights/submissions call creates an insight in the feedback inbox of the product your token targets:

  • Send content (the insight text) and an optional sourceEmail. A successful call returns 201 Created with a feedbackId and a correlation id for support lookups.

  • Submitted insights behave like any other feedback: they land in the right product inbox, trigger your feedback automations, and are written to the audit/activity log. They're tagged with an Api source, so you can tell them apart from Zapier, portal, in-app, or Chrome submissions — and use that as its own automation condition.

  • Server-side only: the token is a Bearer credential in the Authorization header. No browser CORS, client-side JavaScript, query-string, or cookie tokens. Rate limiting and safe JSON errors are built in, and errors never leak the token secret.

Who can create the workspace API token

Workspace Admins and Subscription Admins can create and revoke tokens.

How to create your workspace API token

  1. Visit your profile

  2. Select "Workspace settings"

  3. Choose the "API Tokens" tab

  4. Click on "Create token"

  5. Enter token details (name, target proeduct, expiration)

  6. Select "Create token"

  7. Copy your token and close the window


Learn more about:

Did this answer your question?