Create and Dispatch Message with iContact API on New Event Received (Instant) from Hookdeck API

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

Trigger workflow on

New Event Received (Instant) from the Hookdeck 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 Hookdeck 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 Event Received (Instant) trigger
1. Connect your Hookdeck account
2. Optional- Configure Connection Name
3. Optional- Configure Description
4. Optional- Select a Pre-exisiting Source
5. Optional- Configure New Source
6. Optional- Configure Destination Name
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 Event Received (Instant) on Hookdeck

Description:Emit new event when a new event is received from a HookDeck source.

Version:0.0.2

Key:hookdeck-new-event-received

View on GitHub

Hookdeck Overview#

The Hookdeck API facilitates the management of webhooks, providing reliable webhook delivery, monitoring, and debugging solutions. With this API on Pipedream, you can automate workflows concerning incoming webhook data—transforming, routing, and ensuring they trigger the subsequent actions without fail. This could range from logging data for analysis, conditionally processing and forwarding webhook events to other endpoints, or integrating with third-party services for extended automation.

Trigger Code#

import app from "../../hookdeck.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "hookdeck-new-event-received",
  name: "New Event Received (Instant)",
  description: "Emit new event when a new event is received from a HookDeck source.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    http: "$.interface.http",
    name: {
      type: "string",
      label: "Connection Name",
      description: "The name of the connection.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the connection.",
      optional: true,
    },
    sourceId: {
      propDefinition: [
        app,
        "sourceId",
      ],
      label: "Pre-exisiting Source",
    },
    source: {
      type: "object",
      label: "New Source",
      description: "An object representing the source of the connection. Object must contain at least `name`. Please check the [documentation](https://hookdeck.com/api-ref#create-a-connection) for more information.",
      default: {
        name: "My New Source",
      },
      optional: true,
    },
    destinationName: {
      type: "string",
      label: "Destination Name",
      description: "The destination name that will be created or updated with Pipedream HTTP endpoint for Pipedream source to receive your event. Existing destination with the same name will be overridden with the new HTTP endpoint",
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      if (this.sourceId && this.source) {
        throw new ConfigurationError("Only one of `Source Id` or `Source` may be provided.");
      }
      if (!this.source && !this.sourceId) {
        throw new ConfigurationError("Either `Source Id` or `Source` must be provided.");
      }
    },
    async activate() {
      const { id } = await this.app.createConnection({
        name: this.name || `Pipedream_Connection_${this.getCurrentDateTime()}`,
        description: this.description,
        source_id: this.sourceId,
        source: this.source,
        destination: {
          name: this.destinationName || `Pipedream_Source_${this.getCurrentDateTime()}`,
          url: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const id = this._getHookId();
      if (id) {
        await this.deleteConnection(id);
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    async deleteConnection(id) {
      await this.app._makeHttpRequest({
        method: "DELETE",
        path: `/connections/${id}`,
      });
    },
    getCurrentDateTime() {
      const now = new Date();
      const year = now.getFullYear();
      const month = (now.getMonth() + 1).toString().padStart(2, "0");
      const day = now.getDate().toString()
        .padStart(2, "0");
      const hours = now.getHours().toString()
        .padStart(2, "0");
      const minutes = now.getMinutes().toString()
        .padStart(2, "0");

      return `${year}${month}${day}${hours}${minutes}`;
    },
    generateMeta() {
      return {
        id: Date.now(),
        summary: "New Event Received",
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body } = event;
    const meta = this.generateMeta();
    this.$emit(body, meta);
  },
};

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
Hookdeck	`app`	`app`	This component uses the Hookdeck app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Connection Name	`name`	`string`	The name of the connection.
Description	`description`	`string`	The description of the connection.
Pre-exisiting Source	`sourceId`	`string`	Select a value from the drop down menu.
New Source	`source`	`object`	An object representing the source of the connection. Object must contain at least `name`. Please check the documentation for more information.
Destination Name	`destinationName`	`string`	The destination name that will be created or updated with Pipedream HTTP endpoint for Pipedream source to receive your event. Existing destination with the same name will be overridden with the new HTTP endpoint

Trigger Authentication#

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

About Hookdeck#

Never miss a webhook again. Our reliable webhook infrastructure gives you full visibility over your webhooks.

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