Create Campaign with Mailchimp API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Mailchimp, Slack and 2,400+ other apps remarkably fast.

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

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

Select this integration
Configure the New Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
Configure the Create Campaign action
1. Connect your Mailchimp account
2. Select a Type
3. Select a List Id
4. Optional- Configure Saved segment ID
5. Optional- Configure Prebuilt segment ID
6. Optional- Select a Segment match
7. Optional- Configure Segment conditions
8. Optional- Configure Subject line
9. Optional- Configure Preview text
10. Optional- Configure Title
11. Optional- Configure From name
12. Optional- Configure Reply to
13. Optional- Configure Use conversation
14. Optional- Configure To name
15. Optional- Configure Folder ID
16. Optional- Configure Authenticate
17. Optional- Configure Auto footer
18. Optional- Configure Inline css
19. Optional- Configure Auto tweet
20. Optional- Configure Auto fb post
21. Optional- Configure FB comments
22. Optional- Configure Template ID
23. Optional- Configure Opens
24. Optional- Configure HTML clicks
25. Optional- Configure Text clicks
26. Optional- Configure Goal tracking
27. Optional- Configure E-commerce tracking
28. Optional- Configure Google analytics
29. Optional- Configure Clicktale
30. Optional- Configure Salesforce campaign
31. Optional- Configure Salesforce notes
32. Optional- Configure Capsule notes
33. Optional- Configure Social image url
34. Optional- Configure Social description
35. Optional- Select a Social title
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.22

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

import common from "../common/base.mjs";
import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.22",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return event;
    },
  },
  sampleEmit,
};

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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

Trigger Authentication#

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

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

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

Create Campaign on Mailchimp

Description:Creates a new campaign draft. [See docs here](https://mailchimp.com/developer/marketing/api/campaigns/add-campaign/)

Version:0.2.2

Key:mailchimp-create-campaign

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.

Action Code#

import mailchimp from "../../mailchimp.app.mjs";
import { removeNullEntries } from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "mailchimp-create-campaign",
  name: "Create Campaign",
  description: "Creates a new campaign draft. [See docs here](https://mailchimp.com/developer/marketing/api/campaigns/add-campaign/)",
  version: "0.2.2",
  type: "action",
  props: {
    mailchimp,
    type: {
      label: "Type",
      type: "string",
      description: "There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.",
      options: constants.CAMPAIGN_TYPE,
    },
    listId: {
      propDefinition: [
        mailchimp,
        "listId",
      ],
      label: "List Id",
      description: "The unique ID of the list",
    },
    savedSegmentId: {
      label: "Saved segment ID",
      type: "integer",
      description: "The ID for an existing saved segment.",
      optional: true,
    },
    prebuiltSegmentId: {
      label: "Prebuilt segment ID",
      type: "string",
      description: "The prebuilt segment ID, if a prebuilt segment has been designated for this campaign.",
      optional: true,
    },
    segmentMatch: {
      label: "Segment match",
      type: "string",
      description: "Segment match type.",
      optional: true,
      options: [
        "any",
        "all",
      ],
    },
    segmentConditions: {
      label: "Segment conditions",
      type: "any",
      description: "Segment match conditions.",
      optional: true,
    },
    subjectLine: {
      label: "Subject line",
      type: "string",
      description: "The subject line for the campaign.",
      optional: true,
    },
    previewText: {
      label: "Preview text",
      type: "string",
      description: "The preview text for the campaign.",
      optional: true,
    },
    title: {
      label: "Title",
      type: "string",
      description: "The title of the campaign.",
      optional: true,
    },
    fromName: {
      label: "From name",
      type: "string",
      description: "The 'from' name on the campaign (not an email address).",
      optional: true,
    },
    replyTo: {
      label: "Reply to",
      type: "string",
      description: "The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.",
      optional: true,
    },
    useConversation: {
      label: "Use conversation",
      type: "boolean",
      description: "Use Mailchimp Conversation feature to manage out-of-office replies.",
      optional: true,
    },
    toName: {
      label: "To name",
      type: "string",
      description: "The campaign's custom to name.",
      optional: true,
    },
    folderId: {
      label: "Folder ID",
      type: "string",
      description: "If the campaign is listed in a folder, the ID for that folder.",
      optional: true,
    },
    authenticate: {
      label: "Authenticate",
      type: "boolean",
      description: "Whether Mailchimp authenticated the campaign. Defaults to true.",
      optional: true,
    },
    autoFooter: {
      label: "Auto footer",
      type: "boolean",
      description: "Automatically append Mailchimp's default footer to the campaign.",
      optional: true,
    },
    inlineCss: {
      label: "Inline css",
      type: "boolean",
      description: "Automatically inline the CSS included with the campaign content.",
      optional: true,
    },
    autoTweet: {
      label: "Auto tweet",
      type: "boolean",
      description: "Automatically tweet a link to the campaign archive page when the campaign is sent.",
      optional: true,
    },
    autoFbPost: {
      label: "Auto fb post",
      type: "any",
      description: "An array of Facebook page ID to auto-post to.",
      optional: true,
    },
    fbComments: {
      label: "FB comments",
      type: "boolean",
      description: "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.",
      optional: true,
    },
    templateId: {
      label: "Template ID",
      type: "integer",
      description: "The ID of the template to use.",
      optional: true,
    },
    opens: {
      label: "Opens",
      type: "boolean",
      description: "Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    htmlClicks: {
      label: "HTML clicks",
      type: "boolean",
      description: "Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    textClicks: {
      label: "Text clicks",
      type: "boolean",
      description: "Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    goalTracking: {
      label: "Goal tracking",
      type: "boolean",
      description: "Whether to enable Goal tracking.",
      optional: true,
    },
    ecomm360: {
      label: "E-commerce tracking",
      type: "boolean",
      description: "Whether to enable eCommerce360 tracking.",
      optional: true,
    },
    googleAnalytics: {
      label: "Google analytics",
      type: "string",
      description: "The custom slug for Google Analytics tracking (max of 50 bytes).",
      optional: true,
    },
    clicktale: {
      label: "Clicktale",
      type: "string",
      description: "The custom slug for ClickTale tracking (max of 50 bytes).",
      optional: true,
    },
    salesforceCampaign: {
      label: "Salesforce campaign",
      type: "boolean",
      description: "Create a campaign in a connected Salesforce account.",
      optional: true,
    },
    salesforceNotes: {
      label: "Salesforce notes",
      type: "boolean",
      description: "Update contact notes for a campaign based on subscriber email addresses.",
      optional: true,
    },
    capsuleNotes: {
      label: "Capsule notes",
      type: "boolean",
      description: "Update contact notes for a campaign based on subscriber email addresses. Must be using Mailchimp's built-in Capsule integration.",
      optional: true,
    },
    socialImageUrl: {
      label: "Social image url",
      type: "string",
      description: "The url for the header image for the preview card.",
      optional: true,
    },
    socialDescritpion: {
      label: "Social description",
      type: "string",
      description: "A short summary of the campaign to display.",
      optional: true,
    },
    socialTitle: {
      label: "Social title",
      type: "string",
      description: "The title for the preview card. Typically the subject line of the campaign.",
      optional: true,
      options: [
        "active",
        "inactive",
      ],
    },
  },
  async run({ $ }) {

    const payload = removeNullEntries({
      "type": this.type,
      "recipients": {
        "list_id": this.listId,
        "segment_ops": {
          "saved_segment_id": this.savedSegmentId,
          "prebuilt_segment_id": this.prebuiltSegmentId,
          "match": this.segmentMatch,
          "conditions": this.segmentConditions,
        },
      },
      "settings": {
        "subject_line": this.subjectLine,
        "preview_text": this.previewText,
        "title": this.title,
        "from_name": this.fromName,
        "reply_to": this.replyTo,
        "use_conversation": this.useConversation,
        "to_name": this.toName,
        "folder_id": this.folderId,
        "authenticate": this.authenticate,
        "auto_footer": this.autoFooter,
        "inline_css": this.inlineCss,
        "auto_tweet": this.autoTweet,
        "auto_fb_post": this.autoFbPost,
        "fb_comments": this.fbComments,
        "template_id": this.templateId,
      },
      "tracking:": {
        "opens": this.opens,
        "html_clicks": this.htmlClicks,
        "text_clicks": this.textClicks,
        "goal_tracking": this.goalTracking,
        "ecomm360": this.ecomm360,
        "google_analytics": this.googleAnalytics,
        "clicktale": this.clicktale,
        "salesforce": {
          "campaign": this.salesforceCampaign,
          "notes": this.salesforceNotes,
        },
        "capsule": {
          "notes": this.capsuleNotes,
        },
      },
      "social_card": {
        "image_url": this.socialImageUrl,
        "description": this.socialDescritpion,
        "title": this.socialTitle,
      },
    });

    const response = await this.mailchimp.createCampaign($, payload);
    response && $.export("$summary", "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
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
Type	`type`	`string`	Select a value from the drop down menu:`regularplaintextabsplitrssvariate`
List Id	`listId`	`string`	Select a value from the drop down menu.
Saved segment ID	`savedSegmentId`	`integer`	The ID for an existing saved segment.
Prebuilt segment ID	`prebuiltSegmentId`	`string`	The prebuilt segment ID, if a prebuilt segment has been designated for this campaign.
Segment match	`segmentMatch`	`string`	Select a value from the drop down menu:`anyall`
Segment conditions	`segmentConditions`	`any`	Segment match conditions.
Subject line	`subjectLine`	`string`	The subject line for the campaign.
Preview text	`previewText`	`string`	The preview text for the campaign.
Title	`title`	`string`	The title of the campaign.
From name	`fromName`	`string`	The 'from' name on the campaign (not an email address).
Reply to	`replyTo`	`string`	The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.
Use conversation	`useConversation`	`boolean`	Use Mailchimp Conversation feature to manage out-of-office replies.
To name	`toName`	`string`	The campaign's custom to name.
Folder ID	`folderId`	`string`	If the campaign is listed in a folder, the ID for that folder.
Authenticate	`authenticate`	`boolean`	Whether Mailchimp authenticated the campaign. Defaults to true.
Auto footer	`autoFooter`	`boolean`	Automatically append Mailchimp's default footer to the campaign.
Inline css	`inlineCss`	`boolean`	Automatically inline the CSS included with the campaign content.
Auto tweet	`autoTweet`	`boolean`	Automatically tweet a link to the campaign archive page when the campaign is sent.
Auto fb post	`autoFbPost`	`any`	An array of Facebook page ID to auto-post to.
FB comments	`fbComments`	`boolean`	Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
Template ID	`templateId`	`integer`	The ID of the template to use.
Opens	`opens`	`boolean`	Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
HTML clicks	`htmlClicks`	`boolean`	Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
Text clicks	`textClicks`	`boolean`	Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
Goal tracking	`goalTracking`	`boolean`	Whether to enable Goal tracking.
E-commerce tracking	`ecomm360`	`boolean`	Whether to enable eCommerce360 tracking.
Google analytics	`googleAnalytics`	`string`	The custom slug for Google Analytics tracking (max of 50 bytes).
Clicktale	`clicktale`	`string`	The custom slug for ClickTale tracking (max of 50 bytes).
Salesforce campaign	`salesforceCampaign`	`boolean`	Create a campaign in a connected Salesforce account.
Salesforce notes	`salesforceNotes`	`boolean`	Update contact notes for a campaign based on subscriber email addresses.
Capsule notes	`capsuleNotes`	`boolean`	Update contact notes for a campaign based on subscriber email addresses. Must be using Mailchimp's built-in Capsule integration.
Social image url	`socialImageUrl`	`string`	The url for the header image for the preview card.
Social description	`socialDescritpion`	`string`	A short summary of the campaign to display.
Social title	`socialTitle`	`string`	Select a value from the drop down menu:`activeinactive`

Action 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:

Create Campaign with Mailchimp API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Mailchimp, Slack and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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