Add or Update a contact with Brevo API on New Email from Email API

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

Trigger workflow on

New Email from the Email API

Next, do this

Add or Update a contact 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 Email 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 Email trigger
1. Connect your Email account
Configure the Add or Update a contact action
1. Connect your Brevo account
2. Optional- Select a Contact
3. Configure Email
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 Email on Email

Description:Get a unique address where you can send emails to trigger your workflow.

Version:0.0.1

Key:email-new-email

View on GitHub

Trigger Code#

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

export default {
  name: "New Email",
  version: "0.0.1",
  key: "email-new-email",
  description: "Get a unique address where you can send emails to trigger your workflow.",
  props: {
    email,
  },
  type: "source",
  methods: {},
  async run() {},
};

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
Email	`email`	`app`	This component uses the Email app.

Trigger Authentication#

The Email API does not require authentication.

About Email#

Trigger workflows on new emails, and send emails to yourself as part of a Pipedream workflow.

Action#

Add or Update a contact on Brevo

Description:Add or Update a contact

Version:0.0.3

Key:brevo-add-or-update-contact

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-add-or-update-contact",
  name: "Add or Update a contact",
  description: "Add or Update a contact",
  version: "0.0.3",
  type: "action",
  props: {
    brevo,
    providedIdentifier: {
      type: "string",
      label: "Contact",
      description: "Email OR ID of the contact, if not present the contact will be inserted, it will be used to search the contact, if it can be found the contact will be updated else it will be inserted",
      optional: true,
      reloadProps: true,
      async options({ prevContext }) {
        return this.brevo.getContactsPaginated(prevContext, false);
      },
    },
    email: {
      type: "string",
      label: "Email",
      description: "To either be inserted or updated",
    },
  },
  async additionalProps() {
    const attributesList = await this.brevo.getContactAttributes(this);
    const attributesFields = attributesList.attributes
      .filter((attr) => attr.category === "normal")
      .reduce((acc, actual) => {
        acc[`attribute-${actual.name}`] = {
          type: "string",
          label: actual.name.replace(/(^\w|\s\w)(\S*)/g, (_, m1, m2) => m1.toUpperCase() + m2.toLowerCase()),
          description: "To either be inserted or updated",
          optional: true,
        };
        return acc;
      }, {});
    const dynamicProps = {
      ...attributesFields,
      listIds: {
        type: "string[]",
        label: "Lists",
        description: "Array with ids of each list to be either inserted or updated,\n\n**On update the contact will be removed from previous lists**",
        options: async ({ prevContext }) => {
          return this.brevo.getListsPaginated(prevContext);
        },
      },
    };
    return dynamicProps;
  },
  async run({ $ }) {
    let identifier = this.providedIdentifier;
    const listIds = Object.keys(this.listIds).map((key) => parseInt(this.listIds[key], 10));
    let contact = null;
    if (identifier) {
      try {
        contact = await this.brevo.existingContactByIdentifier($,
          identifier);
      } catch (e) {
        contact = null;
      }
    }

    const attributes = {
      EMAIL: this.email,
    };
    for (let key of Object.keys(this).filter((k) => k.startsWith("attribute-"))) {
      const attribute = this[key];
      if (attribute) {
        attributes[key.replace("attribute-", "")] = attribute;
      }
    }
    $.export("Defined attributes", attributes);

    if (contact) {
      try {
        identifier = contact.id;
        const unlinkListIds = contact.listIds.filter((el) => !listIds.includes(el));
        await this.brevo.updateContact(
          $,
          identifier,
          attributes,
          listIds,
          unlinkListIds,
        );

        $.export("$summary", `Successfully updated contact "${identifier}"`);
      } catch ({ response: { data } }) {
        let errorMessage = data.message;
        if (data.message === "Contact already exist") {
          errorMessage = `A contact with email ${this.email} already exists!`;
        }
        throw new Error(errorMessage);
      }
    } else {
      const inserted = await this.brevo.addContact(
        $,
        attributes,
        listIds,
      );
      identifier = inserted.id;
      $.export("$summary", `Successfully inserted contact "${identifier}"`);
    }
    return this.brevo.existingContactByIdentifier(
      $,
      encodeURIComponent(identifier),
    );
  },
};

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.
Contact	`providedIdentifier`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	To either be inserted or updated