A welcome that arrives while the sign-up page is still open.

# From your sign-up handler, once the account row exists. The idempotency
# key names the account, so a retried handler cannot welcome it twice.
curl -X POST https://app.usenotix.dev/api/v1/emails \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Idempotency-Key: welcome-usr_123" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "Ada at Acme <ada@acme.com>",
    "to": "user@example.com",
    "subject": "Welcome to Acme",
    "templateId": "tpl_welcome",
    "variables": { "firstName": "Chidi", "dashboardUrl": "https://acme.com/app" }
  }'

# 200 { "emailId": "eml_abc123" }

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

export async function onSignUp(user: { id: string; email: string; firstName: string }) {
  const { data, error } = await notix.emails.send(
    {
      from: "Ada at Acme <ada@acme.com>",
      to: user.email,
      templateId: "tpl_welcome",
      variables: {
        firstName: user.firstName,
        dashboardUrl: "https://acme.com/app",
      },
    },
    { idempotencyKey: `welcome-${user.id}` },
  );

  if (error) {
    // Sign-up succeeded; the welcome is not worth failing it for.
    logger.warn({ userId: user.id, error }, "welcome email failed");
    return;
  }

  // Keep the id: the dashboard and the webhook events both key on it.
  await db.user.update({ where: { id: user.id }, data: { welcomeEmailId: data.emailId } });
}

import os
from notix import Notix

notix = Notix(os.environ["NOTIX_API_KEY"])


def on_sign_up(user):
    data, error = notix.emails.send(
        {
            "from": "Ada at Acme <ada@acme.com>",
            "to": user.email,
            "templateId": "tpl_welcome",
            "variables": {
                "firstName": user.first_name,
                "dashboardUrl": "https://acme.com/app",
            },
        },
        options={"idempotency_key": f"welcome-{user.id}"},
    )

    if error:
        # Sign-up succeeded; log and move on.
        log.warning("welcome email failed: %s", error)
        return

    user.welcome_email_id = data["emailId"]
    user.save()

# 1. Create the contact in the book the journey listens to. Created
#    subscribed, it enrols into every "contact added" journey on the book.
curl -X POST https://app.usenotix.dev/api/v1/contactBooks/$BOOK_ID/contacts \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "user@example.com", "firstName": "Chidi",
        "properties": { "plan": "free" } }'

# 200 { "contactId": "ctc_abc123" }

# 2. Or enrol an existing contact into one specific journey yourself.
#    Exactly one of contactId or email; 409 if it already has a run.
curl -X POST https://app.usenotix.dev/api/v1/journeys/$JOURNEY_ID/enroll \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contactId": "ctc_abc123" }'

# 201 { "id": "run_...", "status": "ACTIVE", "currentStep": 0, ... }

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);
const WELCOME_BOOK = "book_onboarding";

export async function onSignUp(user: { email: string; firstName: string; plan: string }) {
  // A contact created subscribed enrols into every "contact added"
  // journey on this book, so the welcome sequence starts here.
  const { data, error } = await notix.contacts.create(WELCOME_BOOK, {
    email: user.email,
    firstName: user.firstName,
    properties: { plan: user.plan },
  });
  if (error) throw new Error(error.message);
  return data.contactId;
}

// For a journey whose trigger is "API" rather than "contact added":
export async function startWinBack(journeyId: string, contactId: string) {
  const { error } = await notix.journeys.enroll(journeyId, { contactId });
  // 409 NOT_UNIQUE means the contact already has a run on this journey.
  if (error && error.code !== "NOT_UNIQUE") throw new Error(error.message);
}

import os
from notix import Notix

notix = Notix(os.environ["NOTIX_API_KEY"])
WELCOME_BOOK = "book_onboarding"


def on_sign_up(user):
    # Created subscribed, the contact enrols into every "contact added"
    # journey on this book, which is where the welcome sequence starts.
    data, error = notix.contacts.create(
        WELCOME_BOOK,
        {
            "email": user.email,
            "firstName": user.first_name,
            "properties": {"plan": user.plan},
        },
    )
    if error:
        raise RuntimeError(error["message"])
    return data["contactId"]


# The Python package has no journeys module yet; enrol with one POST.
def start_win_back(session, journey_id, contact_id):
    r = session.post(
        f"https://app.usenotix.dev/api/v1/journeys/{journey_id}/enroll",
        headers={"Authorization": f"Bearer {os.environ['NOTIX_API_KEY']}"},
        json={"contactId": contact_id},
    )
    if r.status_code not in (201, 409):  # 409: already has a run
        r.raise_for_status()