Search Contacts with Twilio SendGrid API on New or Updated List Segment from Mailchimp API

Pipedream makes it easy to connect APIs for Twilio SendGrid, Mailchimp and 2,700+ other apps remarkably fast.

Trigger workflow on

New or Updated List Segment from the Mailchimp API

Next, do this

Search Contacts with the Twilio SendGrid 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 Mailchimp trigger and Twilio SendGrid action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New or Updated List Segment trigger
1. Connect your Mailchimp account
2. Configure timer
3. Select a Audience List Id
4. Select a Watch for new created or updated segments?
5. Configure Include subscribers from Mailchimp Transactional?
Configure the Search Contacts action
1. Connect your Twilio SendGrid account
2. Optional- Configure Query
3. Optional- Select a Query Field
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 or Updated List Segment on Mailchimp

Description:Emit new event when segment is either created or updated.

Version:0.0.2

Key:mailchimp-new-or-updated-list-segment

View on GitHub

Mailchimp Overview#

The Mailchimp API taps into the heart of your email marketing efforts, allowing you to manage subscribers, campaigns, and reports. With the API, you can automate tasks like syncing subscriber lists, segmenting contacts based on behavior, and personalizing email content to match user profiles. It's a powerful tool for marketers looking to fine-tune their email strategy and maximize engagement.

Trigger Code#

import common from "../common/timer-based.mjs";
import constants from "../constants.mjs";

export default {
  ...common,
  key: "mailchimp-new-or-updated-list-segment",
  name: "New or Updated List Segment",
  description: "Emit new event when segment is either created or updated.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    listId: {
      propDefinition: [
        common.props.mailchimp,
        "listId",
      ],
      description: "The unique ID of the audience list which you'd like to watch for new or updated segments",
    },
    watchFor: {
      type: "string",
      label: "Watch for new created or updated segments?",
      description: "If set to `Created`, it will include new created segments only.  When set to `Updated`, it will only include recently updated segments.",
      options: constants.SEGMENT_WATCH_TYPES,
      optional: false,
    },
    includeTransactional: {
      propDefinition: [
        common.props.mailchimp,
        "includeTransactional",
      ],
    },
  },
  hooks: {
    async deploy() {
      // Emits sample events on the first run during deploy.
      const config = {
        count: 10,
        offset: 0,
      };
      const segments = this.watchFor === "Created"
        ? await this.mailchimp.getAudienceSegmentsByCreatedDate(this.listId, config)
        : await this.mailchimp.getAudienceSegmentsByUpdatedDate(this.listId, config);
      if (!segments?.length) {
        throw new Error("No segment data available");
      }
      const relevantDate = this.watchFor === "Created" ?
        segments[0].created_at
        : segments[0].updated_at;
      segments.forEach(this.processEvent);
      this.setDbServiceVariable("lastRelevantDate", relevantDate);
    },
  },
  methods: {
    ...common.methods,
    generateMeta(eventPayload) {
      if (this.watchFor === "Created") {
        return {
          id: eventPayload.id,
          summary: `A new segment "${eventPayload.name}" was created.`,
          ts: Date.parse(eventPayload.created_at),
        };
      } else {
        const ts = Date.parse(eventPayload.updated_at);
        return {
          id: `${eventPayload.id}${ts}`,
          summary: `Segment "${eventPayload.name}" was updated.`,
          ts,
        };
      }
    },
  },
  async run() {
    let startDateTime = this.getDbServiceVariable("lastRelevantDate");
    const endDateTime = (new Date).toISOString();
    let segments;
    let offset = 0;
    const pageSize = constants.PAGE_SIZE;
    const config = {
      count: pageSize,
      endDateTime,
    };
    do {
      config.offset = offset;
      config.startDateTime = startDateTime;
      segments = this.watchFor === "Created"
        ? segments = await this.mailchimp.getAudienceSegmentsByCreatedDate(this.listId, config)
        : segments = await this.mailchimp.getAudienceSegmentsByUpdatedDate(this.listId, config);
      if (!segments?.length) {
        return;
      }
      segments.forEach(this.processEvent);
      startDateTime = this.watchFor === "Created" ?
        segments[0].created_at
        : segments[0].updated_at;
      this.setDbServiceVariable("lastRelevantDate", startDateTime);
      offset = offset + segments.length;
    } while (segments.length === pageSize);
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
	`timer`	`$.interface.timer`
Audience List Id	`listId`	`string`	Select a value from the drop down menu.
Watch for new created or updated segments?	`watchFor`	`string`	Select a value from the drop down menu:`CreatedUpdated`
Include subscribers from Mailchimp Transactional?	`includeTransactional`	`boolean`	If set to `true`, it will include subscribers from Mailchimp Marketing and Mailchimp Transactional, formerly Mandrill. When set to `false`, it will include subscribers from Mailchimp Marketing only.

Trigger Authentication#

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

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

About Mailchimp#

Mailchimp is a marketing automation and email marketing platform.

Action#

Search Contacts on Twilio SendGrid

Description:Searches contacts with a SGQL query. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/search-contacts)

Version:0.0.5

Key:sendgrid-search-contacts

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import common from "../common/common.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "sendgrid-search-contacts",
  name: "Search Contacts",
  description: "Searches contacts with a SGQL query. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/search-contacts)",
  version: "0.0.5",
  type: "action",
  props: {
    ...common.props,
    query: {
      type: "string",
      label: "Query",
      description: "The query field accepts valid SGQL for searching for a contact (.e.g `email LIKE 'hung.v%'` ). Only the first 50 contacts will be returned. [For more information about SGQL](https://docs.sendgrid.com/for-developers/sending-email/segmentation-query-language)",
      optional: true,
    },
    queryField: {
      type: "string",
      label: "Query Field",
      description: "Select the field to search",
      options: constants.CONTACT_FIELDS,
      reloadProps: true,
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.queryField) {
      props.queryValue = {
        type: "string",
        label: "Query Value",
        description: `The ${this.queryField} value to search for`,
      };
      props.matchCase = {
        type: "string",
        label: "Query Match Case",
        description: "`Exact` will return only exact matches. `Fuzzy` is case insensitive and will return matches that include the search term.",
        options: constants.QUERY_MATCH_CASE_OPTIONS,
        default: "Fuzzy",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      query,
      queryField,
      queryValue,
      matchCase,
    } = this;

    if ((query && queryField) || (!query && !queryField)) {
      throw new ConfigurationError("Please enter only one of `query` or `queryField`");
    }

    let q;
    if (query) {
      q = query;
    } else {
      q = matchCase === "Fuzzy"
        ? `lower(${queryField}) LIKE '%${queryValue}%'`
        : `${queryField} = '${queryValue}'`;
    }

    console.log(q);
    const resp = await this.sendgrid.searchContacts(q);
    $.export("$summary", "Successfully completed search");
    return resp;
  },
};

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
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
Query	`query`	`string`	The query field accepts valid SGQL for searching for a contact (.e.g `email LIKE 'hung.v%'` ). Only the first 50 contacts will be returned. For more information about SGQL
Query Field	`queryField`	`string`	Select a value from the drop down menu:`alternate_emailsaddress_line_1address_line_2citycontact_idcountryemailemail_domainsevent_dataevent_sourceevent_timestampevent_typefirst_namelast_namepostal_codestate_province_regioncreated_atupdated_at`

Search Contacts with Twilio SendGrid API on New or Updated List Segment from Mailchimp API

Pipedream makes it easy to connect APIs for Twilio SendGrid, Mailchimp and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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