Send Transactional Email with Brevo API on New Booking Created from Square API

Pipedream makes it easy to connect APIs for Brevo, Square and 2,900+ other apps remarkably fast.

Trigger workflow on

New Booking Created from the Square API

Next, do this

Send Transactional Email with the Brevo API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Square trigger and Brevo action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Booking Created trigger
1. Connect your Square account
2. Configure timer
Configure the Send Transactional Email action
1. Connect your Brevo account
2. Configure Use Template
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Booking Created on Square

Description:Emit new event for every new booking created. [See the docs](https://developer.squareup.com/reference/square/bookings-api/list-bookings)

Version:0.0.3

Key:square-new-booking-created

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Trigger Code#

import base from "../common/base-polling.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "square-new-booking-created",
  name: "New Booking Created",
  description: "Emit new event for every new booking created. [See the docs](https://developer.squareup.com/reference/square/bookings-api/list-bookings)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { bookings } = await this.square.listBookings({
        params: {
          ...this.getBaseParams(),
        },
      });
      if (!(bookings?.length > 0)) {
        return;
      }
      this._setLastTs(Date.parse(bookings[bookings.length - 1].created_at));
      bookings?.slice(-constants.MAX_HISTORICAL_EVENTS)
        .forEach((booking) => this.$emit(booking, this.generateMeta(booking)));
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
      };
    },
    generateMeta(booking) {
      return {
        id: booking.id,
        summary: `Booking created: ${booking.id}`,
        ts: Date.parse(booking.created_at),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs;
    let cursor;

    do {
      const response = await this.square.listBookings({
        params: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { bookings } = response;
      if (!(bookings?.length > 0)) {
        break;
      }
      newLastTs = Date.parse(bookings[bookings.length - 1].created_at);
      for (const booking of bookings) {
        if (Date.parse(booking.created_at) > lastTs) {
          this.emitEvent(booking);
        }
      }
      cursor = response?.cursor;
    } while (cursor);

    this._setLastTs(newLastTs);
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Square	`square`	`app`	This component uses the Square app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

Square uses OAuth authentication. When you connect your Square account, Pipedream will open a popup window where you can sign into Square and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Square API.

Pipedream requests the following authorization scopes when you connect your account:

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

About Square#

Solutions & Tools to Grow Your Business

Action#

Send Transactional Email on Brevo

Description:Send transactional email. [See the docs](https://developers.brevo.com/reference/sendtransacemail) for more information.

Version:0.0.2

Key:brevo-send-transactional-email

View on GitHub

Brevo Overview#

The Brevo API lets you automate and integrate your user and access management tasks right within Pipedream. With Brevo's API, you can manage users, groups, permissions, and more, streamlining how you control access to your resources. By crafting workflows on Pipedream, you can connect Brevo with other apps to create custom, automated processes that suit your specific business needs.

Action Code#

import brevo from "../../brevo.app.mjs";

export default {
  key: "brevo-send-transactional-email",
  name: "Send Transactional Email",
  description: "Send transactional email. [See the docs](https://developers.brevo.com/reference/sendtransacemail) for more information.",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    brevo,
    useTemplate: {
      type: "boolean",
      label: "Use Template",
      description: "Should use template?",
      reloadProps: true,
    },
  },
  async additionalProps() {
    const dynamicProps = {};
    if (this.useTemplate) {
      dynamicProps.templateId = {
        label: "Template Id",
        type: "integer",
        min: 0,
        max: Number.MAX_SAFE_INTEGER,
        description: "Id of the template.",
        options: async ({ prevContext }) => {
          return this.brevo.getTemplatesPaginated(prevContext);
        },
      };
    } else {
      dynamicProps.sender = {
        type: "string",
        label: "Sender",
        description: "Pass name (optional) and email or id of sender from which emails will be sent.\nName will be ignored if passed along with sender id.\n**Example:** `{ \"name\": \"John Doe\", \"email\": \"john@doe.com\" }` or `{ \"id\": 1 }`",
        options: async ({ prevContext }) => {
          return this.brevo.getSendersFormattedOptions(prevContext);
        },
      };
      dynamicProps.subject = {
        type: "string",
        label: "Subject",
        description: "Subject of the message.",
      };
      dynamicProps.htmlContent = {
        type: "string",
        label: "Html Content",
        description: "HTML body of the message.",
      };
      dynamicProps.textContent = {
        type: "string",
        label: "Text Content",
        optional: true,
        description: "Plain Text body of the message.",
      };
    }
    const props = {
      ...dynamicProps,
      replyTo: {
        type: "string",
        label: "Reply To",
        optional: false,
        description: "Email (required), along with name (optional), on which transactional mail recipients will be able to reply back.\n\n**Example:** `{ \"name\": \"John Doe\", \"email\": \"john@doe.com\" }`",
        options: async ({ prevContext }) => {
          return this.brevo.getSendersFormattedOptions(prevContext);
        },
      },
      to: {
        type: "string[]",
        label: "To",
        description: "List of email addresses and names (optional) of the recipients.\n\n**Example:** `[{ \"name\": \"John Doe\", \"email\": \"john@doe.com\" }, { \"name\": \"Jane Doe\", \"email\": \"jane@doe.com\" }]`",
        optional: false,
        options: async ({ prevContext }) => {
          return this.brevo.getContactsPaginated(prevContext, true);
        },
      },
      cc: {
        type: "string[]",
        label: "CC",
        optional: true,
        description: "List of email addresses and names (optional) of the recipients in cc.\n\n**Example:** `[{ \"name\": \"John Doe\", \"email\": \"john@doe.com\" }, { \"name\": \"Jane Doe\", \"email\": \"jane@doe.com\" }]`",
        options: async ({ prevContext }) => {
          return this.brevo.getContactsPaginated(prevContext, true);
        },
      },
      bcc: {
        type: "string[]",
        label: "BCC",
        optional: true,
        description: "List of email addresses and names (optional) of the recipients in bcc.\n\n**Example:** `[{ \"name\": \"John Doe\", \"email\": \"john@doe.com\" }, { \"name\": \"Jane Doe\", \"email\": \"jane@doe.com\" }]`",
        options: async ({ prevContext }) => {
          return this.brevo.getContactsPaginated(prevContext, true);
        },
      },
      tags: {
        type: "string[]",
        label: "Tags",
        optional: true,
        description: "Tag your emails to find them more easily.",
      },
      params: {
        type: "string",
        label: "Params",
        description: "All key-value properties that will be replaced in the template e.g. `{\"ORDER\": 12345, \"DATE\": \"12/06/2019\"}`",
        optional: true,
      },
    };

    return props;
  },
  methods: {
    formatEmailProp(prop, field) {
      if (typeof (prop) === "string") {
        prop = JSON.parse(prop);
      }
      if (!Array.isArray(prop)) {
        throw new Error(`Field "${field}" should be an array`, prop);
      }
      if (typeof prop[0] === "string") {
        return Object.keys(prop).map((key) => JSON.parse(prop[key]));
      }
      return prop;
    },
  },
  async run({ $ }) {
    const sender = this.sender ?
      JSON.parse(this.sender) :
      null;
    const replyTo = this.replyTo ?
      JSON.parse(this.replyTo) :
      null;
    const params = this.params ?
      JSON.parse(this.params) :
      null;

    const tags = this.tags ?
      Object.keys(this.tags).map((key) => this.tags[key])
      : null;
    const to = this.to
      ? this.formatEmailProp(this.to, "To")
      : null;
    const cc = this.cc
      ? this.formatEmailProp(this.cc, "CC")
      : null;
    const bcc = this.bcc
      ? this.formatEmailProp(this.bcc, "BCC")
      : null;

    if (!Array.isArray(to) || to.length === 0) {
      throw new Error("Must provide field \"To\".");
    }

    const emailSent = await this.brevo.sendTransactionalEmail(
      $,
      this.useTemplate,
      this.templateId,
      sender,
      replyTo,
      to,
      this.subject,
      this.htmlContent,
      this.textContent,
      tags,
      cc,
      bcc,
      params,
    );
    $.export("$summary", "Transactional email successfully sent");
    return emailSent;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Brevo	`brevo`	`app`	This component uses the Brevo app.
Use Template	`useTemplate`	`boolean`	Should use template?

Action Authentication#

Brevo uses API keys for authentication. When you connect your Brevo account, Pipedream securely stores the keys so you can easily authenticate to Brevo APIs in both code and no-code steps.

About Brevo#

Brevo helps you grow your business. Build customer relationships across email, SMS, chat, and more. Use the tools you need, when you need them.

More Ways to Connect Brevo + Square#

Other Popular Integrations#

Send Transactional Email with Brevo API on Custom Webhook Events from Square API

Square + Brevo

Send Transactional Email with Brevo API on New Booking Created from Square API

Pipedream makes it easy to connect APIs for Brevo, Square and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular