Channel Automation

channelautomation

A lot of open-source invoice management apps are built with Laravel. As a Javascript developer, I wanted to build the “React Solution” for devs that are familiar with React and Javascript. A problem I found when building with services in Node.js is that there is no built-in mailer. So, I had to find a 3rd party service to do that for me. In this article, I will be integrating to send emails for this project . Courier https://github.com/fazzaamiarso/invoys Pre-requisites As this article isn’t your typical follow-along (more like “please sit tight and see how I do it”), it’s not mandatory to be familiar with all technologies used. However, familiarity with Typescript and Next.js will be beneficial for quicker understanding. Technologies in this blog: : type-safety and auto-completion are the best, right? Typescript : a production-ready framework to build a full-stack app, even for beginners. Next.js : a great ORM to work with databases. We use Prisma because of its type-safety and auto-completion, providing great developer experience with typescript added. Prisma : enable us to easily build end-to-end type-safety between our Next.js client and server. Trpc Courier API: a great service/platform to handle our notifications, such as email, SMS, and much more. You can find the full for reference. source code here Goals Before building the features, let’s define our goals. Send invoice link to client’s email. Send a reminder a day before an invoice’s due date. Cancel an invoice due date reminder when the invoice is already paid. Handling network errors. Part 1: Setup Courier Platform Let’s head over to the Courier Dashboard. By default, it’s in a production environment. Since I want to test things out, I’m going to change to the test environment by clicking the dropdown in the top-right corner. We can copy all templates later to production or vice-versa. Now, I will create a for my email notifications. brand I’m just going to add a logo (beware that the logo width is fixed to 140px) on the header and social links on the footer. The designer UI is pretty straightforward, so here is the final result. Don’t forget to publish the changes. Part 2: Send Invoice to Email Currently, the send email button on the UI is doing nothing. I’m going to create a file in to keep all Courier-related code. Also, I will use which already abstracted all Courier API endpoints to functions. courier.ts src/lib/ courier node.js client library Before I build the functionality, let’s create the email notification design within Courier’s Designer and set up the Gmail provider. On the email designer page, we will see that the created brand is already integrated. After that, let’s design the template accordingly with the needed data. Here is the final result. Notice the value with that becomes green, it means it's a variable that can be inserted dynamically. I also set the 'See Invoice' button (or action) with a variable. {} Before I can use the template, I need to create a by clicking the preview tab. Then, it will show a prompt to name the event and set in JSON format. That data field is what will populate the value of the green variables (the data can be set from code also). Since it's a test event, I will fill it with arbitrary values. test event data {} Next, I will publish the template so I can use it. Then, go to send tab. It will show the necessary code to send the email programmatically and the will be populated with the previous that I created. data test event Backend I will copy the test to the file and copy the snippet to . AUTH_TOKEN .env src/lib/courier.ts const authToken = process.env.COURIER_AUTH_TOKEN;

// email to receive all sent notifications in DEVELOPMENT mode
const testEmail = process.env.COURIER_TEST_EMAIL;

const INVOICE_TEMPLATE_ID = <TEMPLATE_ID>;

const courierClient = CourierClient({
  authorizationToken: authToken,
}); Create a function that will be responsible for sending an email. To send an email from the code, I use the function. sendInvoice courierClient.send() // src/lib/courier.ts

export const sendInvoice = async ({
  customerName,
  invoiceNumber,
  invoiceViewUrl,
  emailTo,
  productName,
  dueDate,
}: SendInvoice) => {

const recipientEmail = process.env.NODE_ENV === "production" ? emailTo : testEmail;

const { requestId } = await courierClient.send({
      message: {
        to: {
          email: recipientEmail,
        },
        template: INVOICE_TEMPLATE_ID,
        // Data for courier template designer
        data: {
          customerName,
          invoiceNumber,
          invoiceViewUrl,
          productName,
          dueDate,
        },
      },
    });
    return requestId
}; Define types for the function. sendInvoice // src/lib/courier.ts

interface SendInvoice {
  productName: string;
  dueDate: string;
  customerName: string;
  invoiceNumber: string;
  invoiceViewUrl: string;
  emailTo: string;
} Now that I can send the email, I will call it in the trpc endpoint that resides in . sendEmail src/server/trpc/router/invoice.ts Just remember that trpc endpoint is a Next.js API route. In this case, sendEmail will be the same as calling the /api/trpc/sendEmail route with fetch under the hood. For more explanation . https://trpc.io/docs/quickstart // src/server/trpc/router/invoice.ts
import { sendInvoice } from '@lib/courier';
import { dayjs } from '@lib/dayjs';

// .....SOMEWHERE BELOW
  sendEmail: protectedProcedure
    .input(
      z.object({
        customerName: z.string(),
        invoiceNumber: z.string(),
        invoiceViewUrl: z.string(),
        emailTo: z.string(),
        invoiceId: z.string(),
        productName: z.string(),
        dueDate: z.date(),
      })
    )
    .mutation(async ({ input }) => {
      const invoiceData = {
        ...input,
        dueDate: dayjs(input.dueDate).format('D MMMM YYYY'),
      };

      await sendInvoice(invoiceData);
    }), For those who are unfamiliar with trpc, what I did is the same as handling a request. Let's break it down. POST Trpc way of defining by validating with Zod. Here I define all data that are needed for the function. request input from client sendInvoice .input(
      z.object({
        customerName: z.string(),
        invoiceNumber: z.string(),
        invoiceViewUrl: z.string(),
        emailTo: z.string(),
        invoiceId: z.string(),
        productName: z.string(),
        dueDate: z.date(),
      })
    ) Define a request handler (mutation). POST // input from before
 .mutation(async ({ input }) => {
      const invoiceData = {
        ...input,
        // format a date to string with a defined format. 
        dueDate: dayjs(input.dueDate).format('D MMMM YYYY'), // ex.'2 January 2023'
      };

      // send the email
      await sendInvoice(invoiceData);
    }), Frontend Now, I can start to add the functionality to the send email button. I’m going to use the function which is a thin wrapper of useMutation`. trpc.useMutation() tanstack-query's Let’s add the mutation function. On successful response, I want to send a success toast on UI. //src/pages/invoices/[invoiceId]/index.tsx
import toast from 'react-hot-toast';

const InvoiceDetail: NextPage = () => {
// calling the `sendEmail` trpc endpoint with tanstack-query.
  const sendEmailMutation = trpc.invoice.sendEmail.useMutation({
    onSuccess() {
      toast.success('Email sent!');
    }
  });

} I can just use the function as an inline handler, but I want to create a new handler for the button. //src/pages/invoices/[invoiceId]/index.tsx

 // still inside the InvoiceDetail component
 const sendInvoiceEmail = () => {
    const hostUrl = window.location.origin;

   // prevent a user from spamming when the API call is not done.
    if (sendEmailMutation.isLoading) return;

    // send input data to `sendEmail` trpc endpoint
    sendEmailMutation.mutate({
      customerName: invoiceDetail.customer.name,
      invoiceNumber: `#${invoiceDetail.invoiceNumber}`,
      invoiceViewUrl: `${hostUrl}/invoices/${invoiceDetail.id}/preview`,
      emailTo: invoiceDetail.customer.email,
      invoiceId: invoiceDetail.id,
      dueDate: invoiceDetail.dueDate,
      productName: invoiceDetail.name,
    });
  }; Now I can attach the handler to the send email button. //src/pages/invoices/[invoiceId]/index.tsx

<Button
   variant="primary"
   onClick={sendInvoiceEmail}
   isLoading={sendEmailMutation.isLoading}>
   Send to Email
</Button> Here’s the working UI. Part 3: Send Payment Reminder To schedule a reminder that will be sent a day before an invoice’s due date, I’m going to use . Courier’s Automation API First, let’s design the email template in Courier designer. As I already go through the process before, here is the final result. Before adding the function, define the types for the parameter and refactor the types. // src/lib/courier

interface CourierBaseData {
  customerName: string;
  invoiceNumber: string;
  invoiceViewUrl: string;
  emailTo: string;
}

interface SendInvoice extends CourierBaseData {
  productName: string;
  dueDate: string;
}

interface ScheduleReminder extends CourierBaseData {
  scheduledDate: Date;
  invoiceId: string;
} Now, I add the function to scheduleReminder src/lib/courier //src/pages/invoices/[invoiceId]/index.tsx

// check if the development environment is production
const __IS_PROD__ = process.env.NODE_ENV === 'production';

const PAYMENT_REMINDER_TEMPLATE_ID = '<TEMPLATE_ID>';

export const scheduleReminder = async ({
  scheduledDate,
  emailTo,
  invoiceViewUrl,
  invoiceId,
  customerName,
  invoiceNumber,
}: ScheduleReminder) => {

  // delay until a day before due date in production, else 20 seconds after sent for development
  const delayUntilDate = __IS_PROD__
    ? scheduledDate
    : new Date(Date.now() + SECOND_TO_MS * 20);

  const recipientEmail = __IS_PROD__ ? emailTo : testEmail;

   // define the  automation steps programmatically
   const { runId } = await courierClient.automations.invokeAdHocAutomation({
     automation: {
       steps: [
         // 1. Set delay for the next steps until given date in ISO string
          { action: 'delay', until: delayUntilDate.toISOString() },

          // 2. Send the email notification. Equivalent to `courierClient.send()`
          {
            action: 'send',
            message: {
              to: { email: recipientEmail },
              template: PAYMENT_REMINDER_TEMPLATE_ID,
              data: {
                invoiceViewUrl,
                customerName,
                invoiceNumber,
              },
            },
          },
        ],
      },
    });

   return runId;
}; To send the reminder, I will call after a successful attempt. Let's modify the trpc endpoint. scheduleReminder sendInvoice sendEmail // src/server/trpc/router/invoice.ts

sendEmail: protectedProcedure
    .input(..) // omitted for brevity
    .mutation(async ({ input }) => {
      // multiplier for converting day to milliseconds.
      const DAY_TO_MS = 1000 * 60 * 60 * 24;

      // get a day before the due date
      const scheduledDate = new Date(input.dueDate.getTime() - DAY_TO_MS * 1);

      const invoiceData = {..}; //omitted for brevity

      await sendInvoice(invoiceData);

      //after the invoice is sent, schedule the reminder
      await scheduleReminder({
        ...invoiceData,
            scheduledDate,
      });
    } Now if I try to send an invoice by email, I should get a reminder 20 seconds later since I’m in the development environment. Part 4: Cancel a reminder Finally, all the features are ready. However, I got a problem, what if a client had paid before the scheduled date for payment reminder? Currently, the reminder email will still be sent. That’s not a great user experience and potentially a confused client. Thankfully, Courier has an automation cancellation feature. Let’s add function that can cancel any automation workflow in . cancelAutomationWorkflow src/lib/courier.ts export const cancelAutomationWorkflow = async ({
  cancelation_token,
}: {
  cancelation_token: string;
}) => {
    const { runId } = await courierClient.automations.invokeAdHocAutomation({
      automation: {
        // define a cancel action, that sends a cancelation_token
        steps: [{ action: 'cancel', cancelation_token }],
      },
    });

   return runId;
}; What is a cancelation_token? It’s a unique token that can be set to an automation workflow, so it’s cancelable by sending a action with a matching . cancel cancelation_token Add cancelation_token to , I use the invoice's Id as a token. scheduleReminder // src/lib/courier.ts

export const scheduleReminder = async (..) => {
  // ...omitted for brevity

  const { runId } = await courierClient.automations.invokeAdHocAutomation({
    automation: {
      // add cancelation token here
      cancelation_token: `${invoiceId}-reminder`,
      steps: [
        { action: 'delay', until: delayUntilDate.toISOString() },

  // ... omitted for brevity I will call when an invoice's status is updated to in the trpc endpoint. cancelAutomationWorkflow PAID updateStatus // src/server/trpc/router/invoice.ts

 updateStatus: protectedProcedure
    .input(..) // omitted for brevity
    .mutation(async ({ ctx, input }) => {
      const { invoiceId, status } = input;

      // update an invoice's status in database
      const updatedInvoice = await ctx.prisma.invoice.update({
        where: { id: invoiceId },
        data: { status },
      });

      // cancel payment reminder automation workflow if the status is paid.
      if (updatedInvoice.status === 'PAID') {

        //call the cancel workflow to cancel the payment reminder for matching cancelation_token.
        await cancelAutomationWorkflow({
          cancelation_token: `${invoiceId}-reminder`,
        });
      }

      return updatedStatus;
    }), Here is the working UI. Part 5: Error Handling An important note when doing network requests is there are possibilities of failed requests/errors. I want to handle the error by throwing it to the client, so it can be reflected in UI. On error, Courier API throws an error with type by default. I will also have all functions' return value in consistent with the below format. CourierHttpClientError src/lib/courier.ts // On Success
type SuccessResponse = { data: any, error: null }

// On Error
type ErrorResponse = { data: any, error: string } Now, I can handle errors by adding a block to all functions in . try-catch src/lib/courier.ts try {
  // ..function code

  // modified return example
  return { data: runId, error: null };

} catch (error) {
  // make sure it's an error from Courier
  if (error instanceof CourierHttpClientError) {
      return { data: error.data, error: error.message };
    } else {
      return { data: null, error: "Something went wrong!" };
    }
} Let’s see a handling example on the trpc endpoint. sendEmail // src/server/trpc/router/invoice.ts

  const { error: sendError } = await sendInvoice(..);
  if (sendError) throw new TRPCClientError(sendError);

  const { error: scheduleError } = await scheduleReminder(..);
  if (scheduleError) throw new TRPCClientError(scheduleError); Part 6: Go To Production Now that all templates are ready, I will copy all assets in the test environment to production. Here is an example. Conclusion Finally, all the features are integrated with Courier. We’ve gone through a workflow of integrating Courier API to a Next.js application. Although it’s in Next.js and trpc, the workflow will be pretty much the same with any other technology. I hope now you can integrate Courier into your application by yourself. Get started now: https://app.courier.com/signup About the Author I’m Fazza Razaq Amiarso, a full-stack web developer from Indonesia. I’m also an Open Source enthusiast. I love to share my knowledge and learning . I occasionally help other developers on in my free time. on my blog FrontendMentor Connect with me on . LinkedIn Quick Links 🔗 Courier Docs 🔗 Contribute to Invoys 🔗 Invoys Motivation Also published . here

Sending an Invoice and Adding a Payment Reminder in Next.js with Courier API

Enviar una factura y agregar un recordatorio de pago en Next.js con Courier API

Envoi d'une facture et ajout d'un rappel de paiement dans Next.js avec l'API Courier

कूरियर एपीआई के साथ नेक्स्ट.जेएस में चालान भेजना और भुगतान अनुस्मारक जोड़ना

Courier API を使用して Next.js に請求書を送信し、支払い通知を追加する

Enviando uma fatura e adicionando um lembrete de pagamento em Next.js com Courier API

Gửi hóa đơn và thêm lời nhắc thanh toán trong Next.js với Courier API

使用 Courier API 在 Next.js 中发送发票并添加付款提醒

Stories, News & Mentions about CHANNELAUTOMATION

Channelautomation’s Stories on HackerNoon