Documentation

Everything you need to wire Synapse in

Start with the quickstart, learn the four core concepts, then dive into the API reference when you are ready to build.

Introduction

Synapse collects events from the tools your customers touch, matches each event to an account, and turns changes in those accounts into signals your team can act on. This guide takes you from an empty workspace to your first alert.

New to Synapse? The quickstart below takes about five minutes and does not require any code.

Quickstart

  1. Create a workspace. Sign up and choose the region where your data will be stored.
  2. Connect a source. Open Settings → Connectors, pick your analytics or billing tool and authorize it.
  3. Check the account view. Within a few minutes, accounts appear with their events on a single timeline.
  4. Set an alert. Choose a metric, a threshold and an owner. You will be notified the next time it is crossed.

Prefer code? Send your first event with a single request:

Terminal
curl https://api.synapse.io/v1/events \
  -H "Authorization: Bearer $SYNAPSE_KEY" \
  -d '{"account":"northwind.com","event":"signed_in"}'

Core concepts

ConceptWhat it is
AccountA customer company, identified by its domain or an ID from your CRM.
EventAnything that happened for an account: a login, a ticket, an invoice.
SignalA meaningful change in an account, such as a usage drop or an upgrade.
AlertA rule that routes a signal to an owner in the channel they use.

Connecting sources

Each connector maps its data to accounts, users and events automatically. After you authorize a source, Synapse imports up to two years of history in the background while new events stream in live. You can review and change the field mapping at any time from the connector's settings.

Setting up alerts

An alert has three parts: a condition (for example, weekly active users down 30%), a scope (all accounts, a segment or a single account) and a route (an owner, a team channel or a webhook). Add an escalation step so that unacknowledged alerts reach a team lead.

Health scores

A health score combines the signals that predict renewal in your business. Start from the default weights, then adjust them in Settings → Health. Every score change shows the signals that caused it, so your team can trust the number.

API reference

The REST API uses JSON over HTTPS and bearer-token authentication. All endpoints are under https://api.synapse.io/v1.

EndpointDescription
POST /eventsSend one event or a batch of up to 1,000.
GET /accounts/:idRead an account with its traits and health score.
PATCH /accounts/:idWrite custom traits to an account.
GET /alertsList alerts and their current state.
POST /webhooksRegister a webhook endpoint.

Webhooks

Webhooks deliver a signed JSON payload for every alert and score change. Verify the Synapse-Signature header with your endpoint secret before trusting a payload. Failed deliveries are retried with exponential backoff for 24 hours.

Rate limits

Growth workspaces can make 1,000 requests per second, Scale workspaces 5,000. Every response includes RateLimit-Remaining and RateLimit-Reset headers. Requests over the limit return status 429 and can be retried after the reset time.