Quickstart

Get SSE running in your project in a few steps.

1. Create an app

Sign in and create a new App from the dashboard. Each App has its own channel namespace and credentials.

2. Connect an event source

Point your backend at the SSE ingest endpoint:

POST https://api.streamsyncengage.com/v1/events
Authorization: Bearer <your_api_key>
Content-Type: application/json

{
  "channel": "notifications",
  "event": "order.shipped",
  "payload": { "order_id": "abc123" }
}

3. Subscribe on the client

Use the SSE client library or a plain WebSocket to subscribe to a channel:

const client = new SSEClient({ appKey: 'your_app_key' });
client.subscribe('notifications', (event) => {
  console.log(event);
});

4. Verify delivery

Check the Events log in the dashboard to confirm your event was received and delivered.

Next steps

• Read Concepts to understand channels, routing, and transforms.
• See the API Reference for the full ingest and subscription API.