Create and Dispatch Message with iContact API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Create and Dispatch Message with the iContact API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create and Dispatch Message with iContact API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + iContact

Try it

Create and Dispatch Message with iContact API on New Submission from Typeform API

Typeform + iContact

Try it

Create and Dispatch Message with iContact API on New Submission (Instant) from Jotform API

Jotform + iContact

Try it

Create and Dispatch Message with iContact API on New Scheduled Tasks from Pipedream API

Pipedream + iContact

Try it

Create and Dispatch Message with iContact API on New Download Counts from npm API

npm + iContact

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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];
  },
};

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
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.

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