Quickstart

This guide shows you how to integrate SeerStack into your application. You’ll learn how to authenticate, identify users, and send your first event.

1. Get your API Key

You need an API key to send data to SeerStack.

Log in to the SeerStack Dashboard.
Go to Settings > Developer.
Copy your Publishable Key.

2. Install the SDK

TypeScript
Ruby

Install the official TypeScript/JavaScript library:

npm install seerstack

Add the gem to your Gemfile:

gem "seerstack"

Then run:

bundle install

Or install directly:

gem install seerstack

3. Initialize the client

TypeScript
Ruby

import Seerstack from 'seerstack';

const client = new Seerstack({
  apiKey: process.env['SEERSTACK_API_KEY'], // e.g. 'sk_live_...'
});

require "seerstack"

seerstack = Seerstack::Client.new(
  api_key: ENV["SEERSTACK_API_KEY"] # e.g. 'sk_live_...'
)

4. Send an event

Send a test event to verify your integration.

TypeScript
Ruby

const response = await client.events.capture({
  name: 'test.event',
  user_id: 'internal_user',
  data: {
    message: 'Hello World',
    browser: 'Chrome'
  }
});

console.log(response.success); // true

response = seerstack.events.capture(
  name: "test.event",
  user_id: "internal_user",
  data: {
    message: "Hello World",
    browser: "Chrome"
  }
)

puts(response.success) # true

Check your Dashboard — you should see the event appear instantly.

5. Identify a user (optional)

Associate user traits to enrich your events with user context.

TypeScript
Ruby

await client.users.identify({
  user_id: 'user_123',
  email: 'grace@hopper.com',
  name: 'Grace Hopper',
  attributes: {
    plan: 'enterprise',
    team_size: 15
  }
});

seerstack.users.identify(
  user_id: "user_123",
  email: "grace@hopper.com",
  name: "Grace Hopper",
  attributes: {
    plan: "enterprise",
    team_size: 15
  }
)

Next steps

Identities

Learn how to attach profiles to your users.

Datasources

Connect your production database for deeper insights.

API Reference

Explore the full API documentation.

Events

Learn event best practices.

Getting Started

Essentials

API Reference

Endpoints

1. Get your API Key

2. Install the SDK

3. Initialize the client

4. Send an event

5. Identify a user (optional)

Next steps

Identities

Datasources

API Reference

Events

​1. Get your API Key

​2. Install the SDK

​3. Initialize the client

​4. Send an event

​5. Identify a user (optional)

​Next steps

Identities

Datasources

API Reference

Events

1. Get your API Key

2. Install the SDK

3. Initialize the client

4. Send an event

5. Identify a user (optional)

Next steps