Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vibefollow.com/llms.txt

Use this file to discover all available pages before exploring further.

Vibefollow is an autonomous Revenue Manager for SaaS. You stream user events from your backend; we ground every follow-up in your product knowledge base and send personalized lifecycle emails from your own domain. Three primitives is all you need:
1

Identify a user

Upsert a user with traits — plan, signup date, role, anything that audience filters and the AI writer should know about.
2

Track the events that matter

Emit lifecycle events — signup, trial started, feature used, subscription changed. The 9 canonical events have typed helpers; custom events are accepted as-is.
3

Verify the signed webhooks

When emails are opened, clicked, replied to, or bounced, Vibefollow signs and POSTs the event back to your endpoint. Verify in one SDK call.
The TypeScript SDK wraps all of it. You can also call the REST endpoints directly — both produce the same outcome.

Quickstart

Identify a user and emit your first event in under a minute.

SDK reference

The VibeFollow class, resource methods, error hierarchy.

Webhooks

Signed deliveries for opens, clicks, replies, bounces, unsubscribes.

How it fits together

Drafts default to autopilot — they auto-send at deadline unless you approve, edit, postpone, or skip first. Quiet hours, throttle, and DKIM verification gates are all on by default.

What you’ll need

An API key

Issued in Settings → Developers → API keys.

A server-side runtime

Node 20+, Cloudflare Workers (with nodejs_compat), Vercel Edge, or Deno. The browser is not supported — your key must stay server-side.

An HTTPS endpoint

Optional — only needed if you want to consume signed webhook deliveries.
Pick a path and head to the Quickstart.