Create and Dispatch Message with iContact API on New Ticket (Instant) from Zendesk API

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

Trigger workflow on

New Ticket (Instant) from the Zendesk 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 Zendesk 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 Ticket (Instant) trigger
1. Connect your Zendesk account
2. Select a Trigger Category ID
3. Optional- Configure Custom Subdomain
4. Optional- Select one or more Fields
5. Optional- Configure JSON Body
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 Ticket (Instant) on Zendesk

Description:Emit new event when a ticket is created

Version:0.2.3

Key:zendesk-new-ticket

View on GitHub

Zendesk Overview#

The Zendesk API enables seamless integration of Zendesk's customer service platform with your existing business processes and third-party applications. By leveraging this API with Pipedream, you can automate ticket tracking, sync customer data, escalate issues, and streamline communication across multiple channels. This can significantly increase efficiency, accelerate response times, and enhance the overall customer experience. Automations can range from simple notifications to complex workflows involving data transformation and multi-step actions across various services.

Trigger Code#

import common from "../common/ticket.mjs";

export default {
  ...common,
  name: "New Ticket (Instant)",
  key: "zendesk-new-ticket",
  type: "source",
  description: "Emit new event when a ticket is created",
  version: "0.2.3",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookName() {
      return "New Ticket Webhook";
    },
    getTriggerTitle() {
      return "New Ticket Trigger";
    },
    getTriggerConditions() {
      return {
        all: [
          {
            field: "update_type",
            value: "Create",
          },
        ],
      };
    },
  },
};

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
Zendesk	`app`	`app`	This component uses the Zendesk 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.
Trigger Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Custom Subdomain	`customSubdomain`	`string`	For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is `examplehelp`
Fields	`fields`	`string[]`	Select a value from the drop down menu.
JSON Body	`jsonBody`	`string`	Custom JSON Body of the incoming payload. Setting `jsonBody` will overwrite the `fields` prop

Trigger Authentication#

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

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

triggers:writewebhooks:writereadtickets:writetickets:readusers:writeorganizations:readorganizations:write

About Zendesk#

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

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

Create and Dispatch Message with iContact API on New Ticket (Instant) from Zendesk API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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