Skip to main content

Quickstart

Get up and running with the Brighten API in minutes. Choose your language and follow along.

1. Get API Key

Sign up and generate a key

2. Make Request

Call the API with your key

3. Set Up Webhooks

Receive real-time events

4. Track Usage

Monitor from the dashboard

Need an API key?

Sign up for a free account to get started.

Sign Up Free
Language:
1

Authentication

Include your API key in the Authorization header of every request.

import { createClient } from '@brighten/sdk';

const brighten = createClient({
  apiKey: 'brtn_live_sk_your_key_here',
});
2

Send a Recognition

Create a new recognition to celebrate a team member.

const { data: recognition } = await brighten.recognitions.create({
  recipient_id: "550e8400-e29b-41d4-a716-446655440001",
  message: "Amazing work on the product launch!",
  points: 50,
});
console.log(`Recognition sent! ID: ${recognition.id}`);
3

Set Up a Webhook

Register an endpoint to receive real-time event notifications.

const { data: webhook } = await brighten.webhooks.create({
  name: "My Integration",
  url: "https://api.myapp.com/webhooks/brighten",
  events: ["recognition.created", "reward.redeemed"],
});
console.log(`Webhook secret: ${webhook.secret}`);
4

Get Analytics

Retrieve organization-level analytics and trends.

const { data: analytics } = await brighten.analytics.summary("30d");
console.log(`Total recognitions: ${analytics.total_recognitions}`);
console.log(`Participation rate: ${analytics.participation_rate}%`);

Next Steps