Create and Dispatch Message with iContact API on New Inbound Message from SMSTools API

Pipedream makes it easy to connect APIs for iContact, SMSTools and 2,700+ other apps remarkably fast.

Trigger workflow on

New Inbound Message from the SMSTools API

Next, do this

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

Select this integration
Configure the New Inbound Message trigger
1. Connect your SMSTools account
2. Configure timer
Configure the Create and Dispatch Message action
1. Connect your iContact account
2. Select a Campaign ID
3. Select a Message Type
4. Configure Subject
5. Optional- Configure HTML Body
6. Optional- Configure Text Body
7. Optional- Configure Message Name
8. Optional- Configure Preview Text
9. Optional- Select a Reply To Campaign Id
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 Inbound Message on SMSTools

Description:Emit new event when a new inbound message is received.

Version:0.0.1

Key:smstools-new-inbound-message

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import smstools from "../../smstools.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "smstools-new-inbound-message",
  name: "New Inbound Message",
  description: "Emit new event when a new inbound message is received.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    smstools,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastId() {
      return this.db.get("lastId") || 0;
    },
    _setLastId(lastId) {
      this.db.set("lastId", lastId);
    },
    async emitEvent(maxResults = false) {
      const lastId = this._getLastId();
      const response = this.smstools.paginate({
        fn: this.smstools.getInboxMessages,
        maxResults,
      });

      let responseArray = [];
      for await (const item of response) {
        if (item.ID <= lastId) break;
        responseArray.push(item);
      }

      if (responseArray.length) {
        this._setLastId(responseArray[0].ID);
      }

      for (const item of responseArray.reverse()) {
        this.$emit(item, {
          id: item.ID,
          summary: `New inbound message from ${item.sender}`,
          ts: Date.parse(item.date),
        });
      }
    },
  },
  hooks: {
    async deploy() {
      await this.emitEvent(25);
    },
  },
  async run() {
    await this.emitEvent();
  },
  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
SMSTools	`smstools`	`app`	This component uses the SMSTools app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your Client ID and Client Secret,

Navigate to your SMSTools account and sign in
Go to “Developers” > “API & Webhooks”

About SMSTools#

Text Message Marketing Platform Low cost Bulk SMS

Action#

Create and Dispatch Message on iContact

Description:Creates and dispatches a new message using custom HTML. [See the documentation](https://help.icontact.com/customers/s/article/Messages-iContact-API?r=153&ui-knowledge-components-aura-actions.KnowledgeArticleVersionCreateDraftFromOnlineAction.createDraftFromOnlineArticle=1)

Version:0.0.1

Key:icontact-create-message

View on GitHub

iContact Overview#

The iContact API provides a programmable way to manage email marketing campaigns, contacts, lists, and messages within iContact's service. Through this API, you can automate the creation and sending of emails, manage subscribers, and track the performance of your campaigns. When used on Pipedream, the iContact API allows you to create serverless workflows that integrate with other apps and services, trigger actions based on various conditions, and automate repetitive tasks.

Action Code#

import { MESSAGE_TYPE_OPTIONS } from "../../common/constants.mjs";
import { checkWarnings } from "../../common/utils.mjs";
import icontact from "../../icontact.app.mjs";

export default {
  key: "icontact-create-message",
  name: "Create and Dispatch Message",
  description: "Creates and dispatches a new message using custom HTML. [See the documentation](https://help.icontact.com/customers/s/article/Messages-iContact-API?r=153&ui-knowledge-components-aura-actions.KnowledgeArticleVersionCreateDraftFromOnlineAction.createDraftFromOnlineArticle=1)",
  version: "0.0.1",
  type: "action",
  props: {
    icontact,
    campaignId: {
      propDefinition: [
        icontact,
        "campaignId",
      ],
    },
    messageType: {
      type: "string",
      label: "Message Type",
      description: "The kind of message being added.",
      options: MESSAGE_TYPE_OPTIONS,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject line of the email.",
    },
    htmlBody: {
      type: "string",
      label: "HTML Body",
      description: "Contains the HTML version of the email message body.",
      optional: true,
    },
    textBody: {
      type: "string",
      label: "Text Body",
      description: "Contains the text version of the email message body.",
      optional: true,
    },
    messageName: {
      type: "string",
      label: "Message Name",
      description: "The reference name of the message. This is used for organizational purposes and will not be seen by your contacts.",
      optional: true,
    },
    previewText: {
      type: "string",
      label: "Preview Text",
      description: "Indicates the preview text that some email systems display before opening the email.",
      optional: true,
    },
    replyToCampaignId: {
      propDefinition: [
        icontact,
        "campaignId",
      ],
      label: "Reply To Campaign Id",
      description: "Indicates the sender property where you want reply emails to be sent to.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      icontact,
      ...message
    } = this;

    const response = await icontact.createMessage({
      $,
      data: {
        message,
      },
    });

    checkWarnings(response);

    $.export("$summary", `Successfully created message with ID: ${response.messages[0].messageId}`);
    return response.messages[0];
  },
};

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
iContact	`icontact`	`app`	This component uses the iContact app.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Message Type	`messageType`	`string`	Select a value from the drop down menu:`{ "label": "Normal - An email message.", "value": "normal" }{ "label": "Confirmation - An email that requests a contact to confirm their subscription", "value": "confirmation" }`
Subject	`subject`	`string`	The subject line of the email.
HTML Body	`htmlBody`	`string`	Contains the HTML version of the email message body.
Text Body	`textBody`	`string`	Contains the text version of the email message body.
Message Name	`messageName`	`string`	The reference name of the message. This is used for organizational purposes and will not be seen by your contacts.
Preview Text	`previewText`	`string`	Indicates the preview text that some email systems display before opening the email.
Reply To Campaign Id	`replyToCampaignId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API's App ID, Username, Password:

Navigate to your iContact account and sign in
Click on the top right dropdown
Go to “Settings and Billing” > “iContact Integrations”
Click “View Details” on one of your Custom API Integrations, or create a new one