Skip to main content
Getting started steps: Project, Configure Connector, Link Account, Test in Playground, Get API Key, Connect Agent Get your first connector running in 5 minutes.
1

Set up your project (optional)

Projects organize your API keys, connectors, and linked accounts.If you’re evaluating StackOne, use the default project. For production, create a dedicated project with the appropriate region.
2

Configure a connector

Before end-users can connect, you need to enable and configure the connector.
  1. Go to Integrations in the dashboard
  2. Click + Configuration
Auth configurations listing

Auth Configurations: View and manage all connector configurations

  1. Search for your provider (e.g., Zendesk, Gmail, Salesforce) and select it
  2. Name the configuration or keep the default (useful when you have multiple configurations for the same provider, e.g., “Salesforce - Production” and “Salesforce - Sandbox”)
  3. Enter your credentials:
    • OAuth connectors: Enter your Client ID and Client Secret from the provider’s developer console
    • API Key connectors: No credentials needed here. End-users enter their own API keys when linking.
  4. (Optional) Toggle specific actions on or off. Linked accounts inherit these restrictions.
  5. Click Save
Auth configuration panel

Auth Configuration: Configure API Key credentials and enable actions

The Connectors section lets you manage all connectors for your project. You can:
  • View all connectors across any categories
  • Enable and configure authentication methods for each connector
  • Access linked accounts and logs for each connector
  • Set defaults when multiple configurations exist for the same connector (this will be used to determine the default configuration to be used when linking an account via the StackOne Hub if no specific configuration ID is given to the Hub)

Full Guide: Auth Configurations →

3

Link an account

End-users connect their accounts through the StackOne Hub. For testing, create one yourself.
  1. Go to Accounts in the dashboard
  2. Click Link Account
  3. Enter the connection details:
    • Origin Owner ID: Your identifier for this tenant (e.g., user ID, customer ID, or organization ID)
    • Origin Owner Name: A human-readable label (e.g., “Acme Corp” or “[email protected]”)
  4. Select the provider you configured in step 2 (e.g., Zendesk)
  5. Complete the authentication flow in the provider’s login screen
Hub connector selection

StackOne Hub: Select your configured provider

After connecting, you’ll have an account_id to use in API calls.
The StackOne Hub is how end-users authenticate and connect their accounts. You can embed it in your app using:
  • React: Use @stackone/hub
  • Standalone: Use the StackOne Connect library for any framework
  • Dashboard: Generate connection links for testing

Full Guide: Linking Accounts →

4

Test in the Playground

The AI Playground lets you test actions with natural language before writing code.
  1. Go to Playground in the dashboard
  2. Select your linked account
  3. Try a prompt like “What tools can I use?” or “List all files”
Playground interface

AI Playground: Select an account and test actions

The Playground uses the same MCP server your agent will use.

Full Guide: AI Playground →

5

Get an API key

  1. Go to API Keys in the dashboard
  2. Click Create API Key and copy it
Store this securely. You’ll use it to authenticate all requests.
API keys authenticate your application with StackOne. Key points:
  • Store securely: Keys are shown only once. Use a password manager or environment variable.
  • Scopes: By default, keys include Platform API (read/write) and Connectors (read-only). Expand the scopes dropdown to enable Connectors write access or customize permissions.
  • Multiple keys: Create separate keys for different environments (dev, staging, production).

Full Guide: API Keys →


Connect Your Agent

Choose your preferred protocol to integrate StackOne with your AI application:

Compare Agent Protocols →

Not sure which to choose? See detailed comparison with code examples.

What’s Next?