Quickstart

This guide walks you through setting up Enbbox and sending your first notification in under 5 minutes.

Prerequisites

• An Enbbox account (sign up here)
• Node.js 18+ installed
• A project created in the Enbbox dashboard

Step 1: Get Your API Key

1. Navigate to your project's Settings → API Keys in the dashboard
2. Copy your API key — you'll need it to authenticate API requests

Step 2: Install the SDKs

Install the client SDK for your frontend and the API client for your server:

# Frontend — React component library
npm install @enbbox/react

# Backend — API client for triggering workflows
npm install @enbbox/api

Step 3: Create a Workflow

In the Enbbox dashboard:

1. Go to Workflows → New Workflow
2. Give it a name, e.g., "Welcome Notification"
3. Add an In-App step
4. Configure the notification content:
   • Subject: Welcome to our app!
   • Body: Hi {{name}}, thanks for signing up. We're glad to have you!
5. Save the workflow

Step 4: Trigger the Workflow

On your server, use the @enbbox/api client to trigger the workflow:

import { Configuration, EventsApi } from "@enbbox/api";

const config = new Configuration({
  apiKey: process.env.ENBBOX_API_KEY,
});

const eventsApi = new EventsApi(config);

// Trigger the workflow
await eventsApi.triggerEvent({
  name: "welcome-notification",
  to: { subscriberId: "user-123" },
  payload: {
    name: "John",
  },
});

Step 5: Add the Inbox Component

Display notifications in your app with the <Inbox /> component:

npm install @enbbox/react

import { Inbox } from "@enbbox/react";

function NotificationBell() {
  return <Inbox projectId="YOUR_PROJECT_ID" subscriberId="user-123" />;
}

That's it! Your users will now see in-app notifications in real-time.

Next Steps

• Core Concepts — Learn about notifications, workflows, and subscribers
• Build a Workflow — Create multi-step, multi-channel workflows
• Inbox Integration — Customize the inbox component
• API Reference — Full REST API documentation