This documentation URL will be retired soon. Start using the Ranla API at https://api.ranla.ai. Docs: docs.ranla.ai.

Instrument your product

Wire Ranla into your SaaS in about ten minutes. This path is for founders and growth leads who want lifecycle email to run on product data — not only POST /emails for password resets.

Only need auth email today? Skip to Quickstart: send email.


What you are setting up

  1. Account + API key on app.ranla.ai
  2. Node SDK (or REST) in your app
  3. Product events Ranla uses for segments and automations
  4. Verified sending domain so campaigns send from your brand
  5. Optional: first automation or agent setup in the dashboard

Ranla reads events from your app. Campaigns and automations react to those events. Sends go through the same API as transactional mail.


1. Create an account and API key

  1. Sign up at app.ranla.ai.
  2. Open Get started (/overview) or API Keys → Create.
  3. Copy the rnl_… secret once.
export RANLA_API_KEY=rnl_your_key_here

2. Install the SDK

npm install @supersend/ranla
import { Ranla } from '@supersend/ranla'

const client = new Ranla(process.env.RANLA_API_KEY!)

Other languages — same API, Ranla defaults (https://api.ranla.ai):

Language Install
Python pip install ranla · from ranla import Ranla
Go go get github.com/Super-Send/supersendtx-sdks/go/ranla
PHP composer require ranla/ranla
Ruby gem install ranla · Ranla::Client

The legacy supersendtx packages on each registry remain supported for existing integrations.


3. Track product events

Send events when something meaningful happens in your product. Ranla uses these for segments, automations, and the growth agent.

await client.events.trigger({
  name: 'user.created',
  user_id: 'user_123',
  email: '[email protected]',
  data: { plan: 'trial', source: 'signup' },
  idempotencyKey: 'evt_user_created_123',
})

Common first events:

Event When to fire
user.created Account or workspace created
user.activated Finished onboarding or first value action
subscription.started Paid or trial started
subscription.churned Cancelled or expired

REST equivalent:

curl -X POST https://api.ranla.ai/events \
  -H "Authorization: Bearer $RANLA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: evt_user_created_123" \
  -d '{
    "name": "user.created",
    "user_id": "user_123",
    "email": "[email protected]",
    "data": { "plan": "trial" }
  }'

See Events API for fields, idempotency, and automation matching.


4. Verify a sending domain

Lifecycle and transactional email must send from a domain you control.

  1. Domains → Add domain in the dashboard.
  2. Add DNS records (Cloudflare one-click if offered).
  3. Verify DNS on the domain page.

Until DNS is verified, use sandbox self-test sends to your account email. See Quickstart: send email §4 for the full DNS table.


Confirm the pipe works before you rely on automations:

curl -X POST https://api.ranla.ai/emails \
  -H "Authorization: Bearer $RANLA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Ranla pipe check",
    "html": "<p>Send path works.</p>"
  }'

Free tier: 3,000 emails/mo · 100/day · 1 domain. Add a payment method to unlock production sends to other recipients.


6. Turn on lifecycle (hire Ranla)

The growth workspace (agent, campaign cycles, autopilot) unlocks when you hire Ranla on a paid band. Until then, /growth shows an upsell — you can still send events and use the send API on the free tier.

In the dashboard after hire:

  1. Open Growth and review what Ranla sees from your events.
  2. Approve or edit a proposed campaign.
  3. Optionally wire an automation for user.created → welcome sequence.

Use Copy setup prompt on Get started to hand the same flow to Cursor or Claude (MCP server).


Next steps