Send Email With Template with Postmark API on Ticket Closed (Instant) from Zendesk API

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

Trigger workflow on

Ticket Closed (Instant) from the Zendesk API

Next, do this

Send Email With Template with the Postmark 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 Postmark action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Ticket Closed (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 Send Email With Template action
1. Connect your Postmark account
2. Select a Template
3. Configure Template Model
4. Configure "From" email address
5. Configure Recipient email address(es)
6. Optional- Configure CC email address(es)
7. Optional- Configure BCC email address(es)
8. Optional- Configure Tag
9. Optional- Configure "Reply To" email address
10. Optional- Configure Custom Headers
11. Optional- Configure Track Opens
12. Optional- Select a Track Links
13. Optional- Configure Attachments
14. Optional- Configure Metadata
15. Optional- Configure Message stream
16. Optional- Configure Inline CSS
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#

Ticket Closed (Instant) on Zendesk

Description:Emit new event when a ticket has changed to closed status

Version:0.2.2

Key:zendesk-ticket-closed

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: "Ticket Closed (Instant)",
  key: "zendesk-ticket-closed",
  type: "source",
  description: "Emit new event when a ticket has changed to closed status",
  version: "0.2.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Closed Webhook";
    },
    getTriggerTitle() {
      return "Ticket Closed Trigger";
    },
    getTriggerConditions() {
      return {
        all: [
          {
            field: "update_type",
            value: "Change",
          },
          {
            field: "status",
            operator: "value",
            value: "closed",
          },
        ],
      };
    },
  },
};

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#

Send Email With Template on Postmark

Description:Send a single email with Postmark using a template [See the documentation](https://postmarkapp.com/developer/api/templates-api#email-with-template)

Version:0.0.4

Key:postmark-send-email-with-template

View on GitHub

Postmark Overview#

The Postmark API enables developers to easily integrate programmatic emailing into their applications. With the API, developers can create, send, and track transactional emails that are designed to enhance user experience and user engagement. The API also provides developers with access to powerful analytics and insights, such as open/click rates, spam complaints, bounces, and unsubscribes.

Action Code#

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

const {
  postmark, ...props
} = common.props;

export default {
  ...common,
  key: "postmark-send-email-with-template",
  name: "Send Email With Template",
  description: "Send a single email with Postmark using a template [See the documentation](https://postmarkapp.com/developer/api/templates-api#email-with-template)",
  version: "0.0.4",
  type: "action",
  props: {
    postmark,
    templateAlias: {
      type: "string",
      label: "Template",
      description: "The template to use for this email.",
      async options ({ page }) {
        const data = await this.postmark.listTemplates(page);
        const options = data.Templates?.map((obj) => {
          return {
            label: obj.Name,
            value: obj.Alias,
          };
        }) ?? [];

        return {
          options,
          context: {
            page,
          },
        };
      },
    },
    templateModel: {
      type: "object",
      label: "Template Model",
      description:
        "The model to be applied to the specified template to generate the email body and subject.",
    },
    ...props,
    inlineCss: {
      type: "boolean",
      label: "Inline CSS",
      description:
        "By default, if the specified template contains an HTMLBody, Postmark will apply the style blocks as inline attributes to the rendered HTML content. You may opt-out of this behavior by passing false for this request field.",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      ...this.getTemplateRequestData(),
      InlineCSS: this.inlineCss,
    };
    const response = await this.postmark.sendEmailWithTemplate({
      $,
      data,
    });
    $.export("$summary", "Sent email with template 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
Postmark	`postmark`	`app`	This component uses the Postmark app.
Template	`templateAlias`	`string`	Select a value from the drop down menu.
Template Model	`templateModel`	`object`	The model to be applied to the specified template to generate the email body and subject.
"From" email address	`fromEmail`	`string`	The sender email address. Must have a registered and confirmed Sender Signature. To include a name, use the format 'Full Name <sender@domain.com>' for the address.
Recipient email address(es)	`toEmail`	`string`	Recipient email address. Multiple addresses are comma separated. Max 50.
CC email address(es)	`ccEmail`	`string`	Cc recipient email address. Multiple addresses are comma separated. Max 50.
BCC email address(es)	`bccEmail`	`string`	Bcc recipient email address. Multiple addresses are comma separated. Max 50.
Tag	`tag`	`string`	Email tag that allows you to categorize outgoing emails and get detailed statistics.
"Reply To" email address	`replyTo`	`string`	Reply To override email address. Defaults to the Reply To set in the sender signature.
Custom Headers	`customHeaders`	`string[]`	List of custom headers to include.
Track Opens	`trackOpens`	`boolean`	Activate open tracking for this email. Note: the email must have `HTML Body` to enable open tracking.
Track Links	`trackLinks`	`string`	Select a value from the drop down menu:`NoneHtmlAndTextHtmlOnlyTextOnly`
Attachments	`attachments`	`string[]`	Each attachment should be a string with the parameters separated by a pipe character `\|`, in the format: `Name\|Content\|ContentType`. Alternatively, you can pass a string representing an object. All three parameters are required: `Name` - the filename with extension, i.e. `readme.txt` `Content` - the base64-encoded string with the binary data for the file, i.e. `dGVzdCBjb250ZW50` `ContentType` - the MIME content type, i.e. `text/plain` Example with pipe-separated parameters: `readme.txt\|dGVzdCBjb250ZW50\|text/plain` Example with JSON-stringified object: `{"Name":"readme.txt","Content":"dGVzdCBjb250ZW50","ContentType":"text/plain"}`
Metadata	`metadata`	`object`	Custom metadata key/value pairs.
Message stream	`messageStream`	`string`	Set message stream ID that's used for sending. If not provided, message will default to the outbound transactional stream.
Inline CSS	`inlineCss`	`boolean`	By default, if the specified template contains an HTMLBody, Postmark will apply the style blocks as inline attributes to the rendered HTML content. You may opt-out of this behavior by passing false for this request field.