Create Draft Campaign with Sendy API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

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

Select this integration
Configure the New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Create Draft Campaign action
1. Connect your Sendy account
2. Configure From Name
3. Configure From Email
4. Configure Reply To
5. Configure Title
6. Configure Subject
7. Optional- Configure Plain Text
8. Configure HTML Text
9. Select a Brand ID
10. Optional- Select one or more List IDs
11. Optional- Configure Segment IDs
12. Optional- Select one or more Exclude List IDs
13. Optional- Configure Exclude Segment IDs
14. Optional- Configure Query String
15. Select a Track Opens
16. Select a Track Clicks
17. Optional- Configure Schedule Date Time
18. Optional- Configure Schedule Timezone
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.6

Key:sendgrid-new-contact

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.

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Create Draft Campaign on Sendy

Description:Creates a new draft campaign ready to be filled in with details. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#create-send-campaigns)

Version:0.0.1

Key:sendy-create-draft-campaign

View on GitHub

Sendy Overview#

The Sendy API allows you to programmatically manage email campaigns, subscribers, and lists. With Pipedream's capabilities, you can leverage Sendy API to create custom workflows that respond to events, synchronize data across platforms, and automate email marketing tasks. Pipedream provides a serverless platform where you can connect Sendy with hundreds of other apps without writing complex code, harnessing the power of Sendy's features with event-driven programming and API integration.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import sendy from "../../sendy.app.mjs";

export default {
  key: "sendy-create-draft-campaign",
  name: "Create Draft Campaign",
  description: "Creates a new draft campaign ready to be filled in with details. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#create-send-campaigns)",
  version: "0.0.1",
  type: "action",
  props: {
    sendy,
    fromName: {
      type: "string",
      label: "From Name",
      description: "The 'From Name' of your campaign.",
    },
    fromEmail: {
      type: "string",
      label: "From Email",
      description: "The 'From Email' of your campaign.",
    },
    replyTo: {
      type: "string",
      label: "Reply To",
      description: "The 'Reply To' of your campaign.",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The 'Title' of your campaign.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The 'Subject' of your campaign.",
    },
    plainText: {
      type: "string",
      label: "Plain Text",
      description: "The 'Plain text version' of your campaign.",
      optional: true,
    },
    htmlText: {
      type: "string",
      label: "HTML Text",
      description: "The 'HTML version' of your campaign.",
    },
    brandId: {
      propDefinition: [
        sendy,
        "brandId",
      ],
    },
    listIds: {
      propDefinition: [
        sendy,
        "listId",
        ({ brandId }) => ({
          brandId,
        }),
      ],
      type: "string[]",
      label: "List IDs",
      description: "A list of List IDs.",
      optional: true,
    },
    segmentIds: {
      type: "string[]",
      label: "Segment IDs",
      description: "A list of segment IDs. Segment ids can be found in the segments setup page.",
      optional: true,
    },
    excludeListIds: {
      propDefinition: [
        sendy,
        "listId",
        ({ brandId }) => ({
          brandId,
        }),
      ],
      type: "string[]",
      label: "Exclude List IDs",
      description: "Lists to exclude from your campaign.",
      optional: true,
    },
    excludeSegmentIds: {
      type: "string[]",
      label: "Exclude Segment IDs",
      description: "Segments to exclude from your campaign. Segment ids can be found in the segments setup page.",
      optional: true,
    },
    queryString: {
      type: "string",
      label: "Query String",
      description: "e.g., Google Analytics tags.",
      optional: true,
    },
    trackOpens: {
      type: "string",
      label: "Track Opens",
      description: "Open tracking behaviour.",
      options: [
        {
          label: "Disabled",
          value: "0",
        },
        {
          label: "Enabled",
          value: "1",
        },
        {
          label: "Anonymous",
          value: "2",
        },
      ],
    },
    trackClicks: {
      type: "string",
      label: "Track Clicks",
      description: "Click tracking behaviour.",
      options: [
        {
          label: "Disabled",
          value: "0",
        },
        {
          label: "Enabled",
          value: "1",
        },
        {
          label: "Anonymous",
          value: "2",
        },
      ],
    },
    scheduleDateTime: {
      type: "string",
      label: "Schedule Date Time",
      description: "Format: June 15, 2021 6:05pm. Minutes in increments of '5', eg. 6pm, 6:05pm, 6:10pm, 6:15pm..",
      optional: true,
    },
    scheduleTimezone: {
      type: "string",
      label: "Schedule Timezone",
      description: "e.g., 'America/New_York'. See the [list of PHP's supported timezones](https://www.php.net/manual/en/timezones.php). This parameter only applies if you're scheduling your campaign with 'Schedule Date Time' parameter. Sendy will use your default timezone if this parameter is empty.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.sendy.createDraftCampaign({
      $,
      data: {
        from_name: this.fromName,
        from_email: this.fromEmail,
        reply_to: this.replyTo,
        title: this.title,
        subject: this.subject,
        plain_text: this.plainText,
        html_text: this.htmlText,
        list_ids: this.listIds && parseObject(this.listIds),
        segment_ids: this.segmentIds && parseObject(this.segmentIds),
        exclude_list_ids: this.excludeListIds && parseObject(this.excludeListIds),
        exclude_segment_ids: this.excludeSegmentIds && parseObject(this.excludeSegmentIds),
        brand_id: this.brandId,
        query_string: this.queryString,
        track_opens: this.trackOpens,
        track_clicks: this.trackClicks,
        schedule_date_time: this.scheduleDateTime,
        schedule_timezone: this.scheduleTimezone,
      },
    });

    $.export("$summary", "Draft campaign created successfully");
    return response;
  },
};

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
Sendy	`sendy`	`app`	This component uses the Sendy app.
From Name	`fromName`	`string`	The 'From Name' of your campaign.
From Email	`fromEmail`	`string`	The 'From Email' of your campaign.
Reply To	`replyTo`	`string`	The 'Reply To' of your campaign.
Title	`title`	`string`	The 'Title' of your campaign.
Subject	`subject`	`string`	The 'Subject' of your campaign.
Plain Text	`plainText`	`string`	The 'Plain text version' of your campaign.
HTML Text	`htmlText`	`string`	The 'HTML version' of your campaign.
Brand ID	`brandId`	`string`	Select a value from the drop down menu.
List IDs	`listIds`	`string[]`	Select a value from the drop down menu.
Segment IDs	`segmentIds`	`string[]`	A list of segment IDs. Segment ids can be found in the segments setup page.
Exclude List IDs	`excludeListIds`	`string[]`	Select a value from the drop down menu.
Exclude Segment IDs	`excludeSegmentIds`	`string[]`	Segments to exclude from your campaign. Segment ids can be found in the segments setup page.
Query String	`queryString`	`string`	e.g., Google Analytics tags.
Track Opens	`trackOpens`	`string`	Select a value from the drop down menu:`{ "label": "Disabled", "value": "0" }{ "label": "Enabled", "value": "1" }{ "label": "Anonymous", "value": "2" }`
Track Clicks	`trackClicks`	`string`	Select a value from the drop down menu:`{ "label": "Disabled", "value": "0" }{ "label": "Enabled", "value": "1" }{ "label": "Anonymous", "value": "2" }`
Schedule Date Time	`scheduleDateTime`	`string`	Format: June 15, 2021 6:05pm. Minutes in increments of '5', eg. 6pm, 6:05pm, 6:10pm, 6:15pm..
Schedule Timezone	`scheduleTimezone`	`string`	e.g., 'America/New_York'. See the list of PHP's supported timezones. This parameter only applies if you're scheduling your campaign with 'Schedule Date Time' parameter. Sendy will use your default timezone if this parameter is empty.