Create Campaign with Mailwizz API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Create Campaign with the Mailwizz 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 Mailwizz 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 Campaign action
1. Connect your Mailwizz account
2. Configure Name
3. Optional- Select a Type
4. Configure From Name
5. Configure From Email
6. Optional- Configure Subject
7. Configure To Name
8. Configure Reply To
9. Configure Send At
10. Select a List UID
11. Optional- Select a Segment UID
12. Select a Template UID
13. Optional- Configure Inline CSS
14. Optional- Configure Plain Text
15. Optional- Configure Auto Plain Text
16. Optional- Configure URL Tracking
17. Optional- Configure JSON Feed
18. Optional- Configure XML Feed
19. Optional- Configure Plain Text Email
20. Optional- Configure Email Stats
21. Optional- Select a Autoresponder Event
22. Optional- Select a Autoresponder Time Unit
23. Optional- Configure Autoresponder Time Value
24. Optional- Select a Autoresponder Open Campaign Id
25. Optional- Configure Cron Job
26. Optional- Configure Cron Job Enabled
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.8

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.8",
  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 Campaign on Mailwizz

Description:Create a new campaign. [See the docs here](https://api-docs.mailwizz.com/?php#create-a-campaign)

Version:0.0.2

Key:mailwizz-create-campaign

View on GitHub

Mailwizz Overview#

Mailwizz offers a potent API that enables automation of email marketing tasks, subscriber management, campaign tracking, and more. Using Pipedream, you can harness this API to create custom workflows that trigger on specific events, process data, or synchronize with other apps. Pipedream's serverless architecture allows you to handle workflows at scale without managing infrastructure.

Action Code#

import { clearObj } from "../../common/utils.mjs";
import mailwizz from "../../mailwizz.app.mjs";

export default {
  key: "mailwizz-create-campaign",
  name: "Create Campaign",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  description: "Create a new campaign. [See the docs here](https://api-docs.mailwizz.com/?php#create-a-campaign)",
  type: "action",
  props: {
    mailwizz,
    name: {
      type: "string",
      label: "Name",
      description: "Campaign name.",
    },
    type: {
      type: "string",
      label: "Type",
      description: "Campaign type. Default is regular.",
      options: [
        "autoresponder",
        "regular",
      ],
      optional: true,
    },
    fromName: {
      type: "string",
      label: "From Name",
      description: "The campaign from name.",
    },
    fromEmail: {
      type: "string",
      label: "From Email",
      description: "The campaign from email address.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The campaign subject.",
      optional: true,
    },
    toName: {
      type: "string",
      label: "To Name",
      description: "The subscriber for which we record the bounce.",
    },
    replyTo: {
      type: "string",
      label: "Reply To",
      description: "RThe camapaign reply to email address.",
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "This will use the timezone which customer selected.",
    },
    listId: {
      propDefinition: [
        mailwizz,
        "listId",
      ],
    },
    segmentId: {
      propDefinition: [
        mailwizz,
        "segmentId",
        ( { listId } ) => ( {
          listId,
        } ),
      ],
      optional: true,
    },
    templateId: {
      propDefinition: [
        mailwizz,
        "templateId",
      ],
    },
    inlineCSS: {
      type: "boolean",
      label: "Inline CSS",
      description: "Accept inline css",
      optional: true,
    },
    plainText: {
      type: "string",
      label: "Plain Text",
      description: "Do not send to autogenerate as default.",
      optional: true,
    },
    autoPlainText: {
      type: "boolean",
      label: "Auto Plain Text",
      description: "Generate plain text template.",
      optional: true,
    },
    urlTracking: {
      type: "boolean",
      label: "URL Tracking",
      description: "Enable/Disable url tracking.",
      optional: true,
    },
    jsonFeed: {
      type: "boolean",
      label: "JSON Feed",
      description: "Enable/Disable JSON feed.",
      optional: true,
    },
    xmlFeed: {
      type: "boolean",
      label: "XML Feed",
      description: "Enable/Disable XML feed.",
      optional: true,
    },
    plainTextEmail: {
      type: "boolean",
      label: "Plain Text Email",
      description: "Enable/Disable the plain text email.",
      optional: true,
    },
    emailStats: {
      type: "string",
      label: "Email Stats",
      description: "A valid email address where the stats will be sent.",
      optional: true,
    },
    autoresponderEvent: {
      type: "string",
      label: "Autoresponder Event",
      description: "The event that is sent after subscribe or after opening the campaign.",
      options: [
        "AFTER-SUBSCRIBE",
        "AFTER-CAMPAIGN-OPEN",
      ],
      optional: true,
    },
    autoresponderTimeUnit: {
      type: "string",
      label: "Autoresponder Time Unit",
      description: "The unit that the autoresponder will be based on.",
      options: [
        "minute",
        "hour",
        "day",
        "week",
        "month",
        "year",
      ],
      optional: true,
    },
    autoresponderTimeValue: {
      type: "integer",
      label: "Autoresponder Time Value",
      description: "The unit time value.",
      optional: true,
    },
    autoresponderOpenCampaignId: {
      propDefinition: [
        mailwizz,
        "campaignId",
      ],
      label: "Autoresponder Open Campaign Id",
      description: "Id of the camapign, only if event is AFTER-CAMPAIGN-OPEN.",
      optional: true,
    },
    cronjob: {
      type: "string",
      label: "Cron Job",
      description: "If this campaign is advanced recurring, you can set a cron job style frequency.",
      optional: true,
    },
    cronjobEnabled: {
      type: "boolean",
      label: "Cron Job Enabled",
      description: "Enable/Disable cron job frequency.",
      optional: true,
    },
  },
  async run ( { $ } ) {
    const {
      mailwizz,
      fromName,
      fromEmail,
      toName,
      replyTo,
      sendAt,
      listId,
      segmentId,
      templateId,
      inlineCSS,
      plainText,
      autoPlainText,
      urlTracking,
      jsonFeed,
      xmlFeed,
      plainTextEmail,
      emailStats,
      autoresponderEvent,
      autoresponderTimeUnit,
      autoresponderTimeValue,
      autoresponderOpenCampaignId,
      cronjobEnabled,
      ...data
    } = this;

    const response = await mailwizz.createCampaign( clearObj( {
      data: {
        campaign: {
          ...data,
          from_name: fromName,
          from_email: fromEmail,
          to_name: toName,
          reply_to: replyTo,
          send_at: sendAt,
          list_uid: listId,
          segment_uid: segmentId,
          template: {
            template_uid: templateId,
            inline_css: inlineCSS,
            plain_text: plainText,
            auto_plain_text: autoPlainText,
          },
          options: {
            url_tracking: urlTracking || "no",
            json_feed: jsonFeed,
            xml_feed: xmlFeed,
            plain_text_email: plainTextEmail,
            email_stats: emailStats,
            autoresponder_event: autoresponderEvent,
            autoresponder_time_unit: autoresponderTimeUnit,
            autoresponder_time_value: autoresponderTimeValue,
            autoresponder_open_campaign_id: autoresponderOpenCampaignId,
            cronjob_enabled: cronjobEnabled,
          },
        },
      },
    } ) );

    $.export( "$summary", `Campaign with id ${response.campaign_uid} was successfully created!` );
    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
Mailwizz	`mailwizz`	`app`	This component uses the Mailwizz app.
Name	`name`	`string`	Campaign name.
Type	`type`	`string`	Select a value from the drop down menu:`autoresponderregular`
From Name	`fromName`	`string`	The campaign from name.
From Email	`fromEmail`	`string`	The campaign from email address.
Subject	`subject`	`string`	The campaign subject.
To Name	`toName`	`string`	The subscriber for which we record the bounce.
Reply To	`replyTo`	`string`	RThe camapaign reply to email address.
Send At	`sendAt`	`string`	This will use the timezone which customer selected.
List UID	`listId`	`string`	Select a value from the drop down menu.
Segment UID	`segmentId`	`string`	Select a value from the drop down menu.
Template UID	`templateId`	`string`	Select a value from the drop down menu.
Inline CSS	`inlineCSS`	`boolean`	Accept inline css
Plain Text	`plainText`	`string`	Do not send to autogenerate as default.
Auto Plain Text	`autoPlainText`	`boolean`	Generate plain text template.
URL Tracking	`urlTracking`	`boolean`	Enable/Disable url tracking.
JSON Feed	`jsonFeed`	`boolean`	Enable/Disable JSON feed.
XML Feed	`xmlFeed`	`boolean`	Enable/Disable XML feed.
Plain Text Email	`plainTextEmail`	`boolean`	Enable/Disable the plain text email.
Email Stats	`emailStats`	`string`	A valid email address where the stats will be sent.
Autoresponder Event	`autoresponderEvent`	`string`	Select a value from the drop down menu:`AFTER-SUBSCRIBEAFTER-CAMPAIGN-OPEN`
Autoresponder Time Unit	`autoresponderTimeUnit`	`string`	Select a value from the drop down menu:`minutehourdayweekmonthyear`
Autoresponder Time Value	`autoresponderTimeValue`	`integer`	The unit time value.
Autoresponder Open Campaign Id	`autoresponderOpenCampaignId`	`string`	Select a value from the drop down menu.
Cron Job	`cronjob`	`string`	If this campaign is advanced recurring, you can set a cron job style frequency.
Cron Job Enabled	`cronjobEnabled`	`boolean`	Enable/Disable cron job frequency.

Action Authentication#

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

To retrieve your API Key,

Navigate to your Mailwizz account and sign in
Click the option with the Star icon in the left navigation menu
Go to “API Keys”

The URL field below is your Mailwizz host domain.

For example, if you have a Mailwizz instance hosted at https://example.com, then enter example.com in the url field below.

Please note that if the MailWizz hosted website doesn't have clean urls enabled, make sure your url has the index.php part of url included, i.e:
example.com/api/index.php