Customer health score Slack alert: template and code

{
  "name": "Customer health score alert",
  "cancelation_token": "health-{{data.account_id}}",
  "nodes": [
    {
      "type": "trigger",
      "trigger_type": "api-invoke"
    },
    {
      "type": "send",
      "channel": "slack",
      "message": {
        "template": "@health-alert-slack",
        "context": {
          "tenant_id": "cs-alerts"
        }
      }
    },
    {
      "type": "delay",
      "mode": "duration",
      "duration": "P1D"
    },
    {
      "type": "send",
      "channel": "email",
      "message": {
        "template": "@health-followup-email",
        "to": {
          "email_override": "{{data.csm_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 }));

// Stores your Slack bot token and alert channel once, on a Courier tenant that
// stands for your company's Slack workspace. The Slack node in journey.json
// names this tenant ("cs-alerts") and has no token or channel of its own: it
// uses the ones on the tenant. Run it once, after setup.ts, and again to rotate
// the token:
//
//   COURIER_API_KEY=pk_... SLACK_BOT_TOKEN=xoxb-... SLACK_ALERT_CHANNEL=C012AB3CD \
//     node --experimental-strip-types setup-slack.ts
//
// SLACK_ALERT_CHANNEL is the channel ID for your customer success channel. To use
// another tenant ID, change it here and in the Slack node's context in journey.json.
import Courier from "@trycourier/courier";

const client = new Courier();

const requireEnv = (name: string) => {
  const value = process.env[name];
  if (!value) throw new Error(`Missing environment variable ${name}`);
  return value;
};

const tenantId = "cs-alerts";
await client.tenants.update(tenantId, {
  name: "Customer success alerts (Slack)",
  user_profile: {
    slack: {
      access_token: requireEnv("SLACK_BOT_TOKEN"),
      channel: requireEnv("SLACK_ALERT_CHANNEL"),
    },
  },
});
console.log(JSON.stringify({ tenantId }));

{
  "channel": "slack",
  "notification": {
    "name": "Health score alert (Slack)",
    "tags": ["recipe", "health-score"],
    "brand": null,
    "subscription": null,
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "slack",
          "elements": [
            {
              "type": "text",
              "content": "Health alert: {{account_name}} dropped to {{health_score}}."
            },
            {
              "type": "text",
              "content": "CSM: {{csm_name}}"
            },
            {
              "type": "text",
              "content": "What changed: {{drivers}}"
            },
            {
              "type": "action",
              "content": "Open the account",
              "href": "https://admin.acme.com/accounts/{{account_id}}"
            }
          ]
        }
      ]
    }
  }
}

{
  "channel": "email",
  "notification": {
    "name": "Health score follow-up (email)",
    "tags": ["recipe", "health-score"],
    "brand": null,
    "subscription": null,
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "email",
          "elements": [
            {
              "type": "meta",
              "title": "{{account_name}}'s health score dropped to {{health_score}}"
            },
            {
              "type": "text",
              "content": "Hi {{csm_name}},"
            },
            {
              "type": "text",
              "content": "{{account_name}}'s health score dropped to {{health_score}}, and we posted it in Slack. What changed: {{drivers}}. If you've already reached out, you can ignore this."
            },
            {
              "type": "action",
              "content": "Open the account",
              "href": "https://admin.acme.com/accounts/{{account_id}}"
            }
          ]
        }
      ]
    }
  }
}