Welcome email sequence: template and code

{
  "name": "Welcome email sequence",
  "cancelation_token": "welcome-{{recipient}}",
  "nodes": [
    {
      "type": "trigger",
      "trigger_type": "api-invoke"
    },
    {
      "id": "welcome-email",
      "type": "send",
      "channel": "email",
      "message": {
        "template": "@welcome-email"
      }
    },
    {
      "type": "delay",
      "mode": "duration",
      "duration": "P1D"
    },
    {
      "type": "send",
      "channel": "email",
      "message": {
        "template": "@setup-nudge-email"
      },
      "conditions": ["profile.setup_completed_at", "does not exist"]
    },
    {
      "type": "send",
      "channel": "inbox",
      "message": {
        "template": "@welcome-inbox"
      },
      "conditions": {
        "AND": [
          ["profile.setup_completed_at", "does not exist"],
          ["send_status.welcome-email", "was not", "OPENED"]
        ]
      }
    },
    {
      "type": "delay",
      "mode": "duration",
      "duration": "P2D"
    },
    {
      "type": "send",
      "channel": "email",
      "message": {
        "template": "@tips-email"
      }
    },
    {
      "type": "exit"
    }
  ]
}

// Creates this recipe's journey from journey.json and the templates/ folder,
// then publishes it. Run it once per workspace:
//
//   COURIER_API_KEY=pk_... node --experimental-strip-types setup.ts
//
// It prints the journey ID and the template IDs it created.
import Courier from "@trycourier/courier";
import { readFileSync, readdirSync } from "node:fs";

const client = new Courier();
const here = new URL(".", import.meta.url);
const readJson = (path: string) =>
  JSON.parse(readFileSync(new URL(path, here), "utf8"));

const spec = readJson("journey.json");

// 1. Create the journey, then the templates its send nodes use.
const journey = await client.journeys.create({
  name: spec.name,
  nodes: [spec.nodes[0], spec.nodes.at(-1)],
});

const templateIds: Record<string, string> = {};
for (const file of readdirSync(new URL("templates/", here))) {
  const key = file.replace(/\.json$/, "");
  const template = await client.journeys.templates.create(
    journey.id,
    readJson(`templates/${file}`)
  );
  await client.journeys.templates.publish(template.id, {
    templateId: journey.id,
  });
  templateIds[key] = template.id;
}

// 2. Save the nodes. In journey.json, "@<template>" stands for the ID of the
// template with that file name. Node IDs must be unique across a workspace,
// so any node ID journey.json names (used by "send_status.<id>" conditions)
// gets this journey's ID added.
const nodeIds = [
  ...JSON.stringify(spec.nodes).matchAll(/"id":"([\w-]+)"/g),
].map((m) => m[1]);
let nodes = JSON.stringify(spec.nodes).replace(/"@([\w-]+)"/g, (_, key) =>
  JSON.stringify(templateIds[key])
);
for (const id of nodeIds)
  nodes = nodes.replace(
    new RegExp(`(?<=[".])${id}(?=")`, "g"),
    `${id}-${journey.id}`
  );
await client.journeys.replace(journey.id, {
  name: spec.name,
  cancelation_token: spec.cancelation_token,
  nodes: JSON.parse(nodes),
});

// 3. Publish, so new runs use this version.
await client.journeys.publish(journey.id);
console.log(JSON.stringify({ journeyId: journey.id, templateIds }));

{
  "channel": "email",
  "notification": {
    "name": "Welcome (email)",
    "tags": ["recipe", "welcome-email-sequence"],
    "brand": null,
    "subscription": null,
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "email",
          "elements": [
            {
              "type": "meta",
              "title": "Welcome to Acme, {{default profile.first_name \"there\"}}"
            },
            {
              "type": "text",
              "content": "Hi {{default profile.first_name \"there\"}},"
            },
            {
              "type": "text",
              "content": "Thanks for signing up. The fastest way to get going is to connect your first data source. It takes about five minutes."
            },
            {
              "type": "action",
              "content": "Get started",
              "href": "https://app.acme.com/setup"
            },
            {
              "type": "text",
              "content": "Reply to this email if anything gets in your way."
            }
          ]
        }
      ]
    }
  }
}

{
  "channel": "email",
  "notification": {
    "name": "Setup nudge (email)",
    "tags": ["recipe", "welcome-email-sequence"],
    "brand": null,
    "subscription": null,
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "email",
          "elements": [
            {
              "type": "meta",
              "title": "Your Acme setup is almost done"
            },
            {
              "type": "text",
              "content": "Hi {{default profile.first_name \"there\"}},"
            },
            {
              "type": "text",
              "content": "You're one step away: connect your first data source. Pick up where you left off."
            },
            {
              "type": "action",
              "content": "Finish setup",
              "href": "https://app.acme.com/setup"
            }
          ]
        }
      ]
    }
  }
}

{
  "channel": "inbox",
  "notification": {
    "name": "Welcome (Inbox)",
    "tags": ["recipe", "welcome-email-sequence"],
    "brand": null,
    "subscription": null,
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "inbox",
          "elements": [
            {
              "type": "meta",
              "title": "Welcome to Acme"
            },
            {
              "type": "text",
              "content": "Start here: connect your first data source."
            },
            {
              "type": "action",
              "content": "Get started",
              "href": "https://app.acme.com/setup"
            }
          ]
        }
      ]
    }
  }
}

{
  "channel": "email",
  "notification": {
    "name": "First-week tips (email)",
    "tags": ["recipe", "welcome-email-sequence"],
    "brand": null,
    "subscription": null,
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "email",
          "elements": [
            {
              "type": "meta",
              "title": "3 things to set up in your first week"
            },
            {
              "type": "text",
              "content": "Hi {{default profile.first_name \"there\"}},"
            },
            {
              "type": "text",
              "content": "Here's what people set up first in Acme:"
            },
            {
              "type": "text",
              "content": "1. Invite your team so everyone sees the same updates."
            },
            {
              "type": "text",
              "content": "2. Turn on Slack alerts for the events you care about."
            },
            {
              "type": "text",
              "content": "3. Set up a weekly summary email."
            },
            {
              "type": "action",
              "content": "Open Acme",
              "href": "https://app.acme.com/setup"
            }
          ]
        }
      ]
    }
  }
}