Generate PDF with Fileforge API on Ticket Pending (Instant) from Zendesk API

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

Trigger workflow on

Ticket Pending (Instant) from the Zendesk API

Next, do this

Generate PDF with the Fileforge 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 Fileforge action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Ticket Pending (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 Generate PDF action
1. Connect your Fileforge account
2. Configure alert
3. Configure HTML Files
4. Optional- Configure Test
5. Optional- Configure Expires At
6. Optional- Configure Filename
7. Optional- Configure Allow Viewing
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 Pending (Instant) on Zendesk

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

Version:0.2.2

Key:zendesk-ticket-pended

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

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#

Generate PDF on Fileforge

Description:Generate a PDF from provided HTML. [See the documentation](https://docs.fileforge.com/api-reference/api-reference/pdf/generate)

Version:0.0.1

Key:fileforge-generate-pdf

View on GitHub

Action Code#

import FormData from "form-data";
import fs from "fs";
import {
  checkTmp,
  parseObject,
} from "../../common/utils.mjs";
import fileforge from "../../fileforge.app.mjs";

export default {
  key: "fileforge-generate-pdf",
  name: "Generate PDF",
  description: "Generate a PDF from provided HTML. [See the documentation](https://docs.fileforge.com/api-reference/api-reference/pdf/generate)",
  version: "0.0.1",
  type: "action",
  props: {
    fileforge,
    alert: {
      type: "alert",
      alertType: "warning",
      content: `An **\`index.html\`** file is required, and will be used as the main document.
      Other documents may also be attached, such as stylesheets or images.
      The path in the **\`filename\`** part of the multipart attachement will be respected during generation.
      **Important notice:** during generation, the **\`index.html\`** file will be processed to include the base URL of the document.
      This is required for assets to be loaded correctly.
      To link your assets from the HTML file, you should not use a leading slash in the URL.
      For example, use **\`<img src="image.jpg" />\`** instead of **\`<img src="/image.jpg" />\`**.`,
    },
    files: {
      type: "string[]",
      label: "HTML Files",
      description: "The HTML files to convert to PDF. Each file should be a valid path to an HTML file saved to the `/tmp` directory (e.g. `/tmp/image.png`). [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory)..",
    },
    test: {
      type: "boolean",
      label: "Test",
      description: "Generate a test document instead of a production document. The generated document will contain a watermark. Defaults to true.",
      optional: true,
    },
    expiresAt: {
      type: "string",
      label: "Expires At",
      description: "The expiration timestamp for the PDF in ISO 8601 format",
      optional: true,
    },
    fileName: {
      type: "string",
      label: "Filename",
      description: "The desired filename for the generated PDF.",
      optional: true,
    },
    allowViewing: {
      type: "boolean",
      label: "Allow Viewing",
      description: "Specifies whether viewing is allowed.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      fileforge,
      files,
      ...data
    } = this;

    const formData = new FormData();
    const parsedFiles = parseObject(files);

    for (const file of parsedFiles) {
      formData.append("files", fs.createReadStream(checkTmp(file)));
    }

    formData.append("options", JSON.stringify({
      ...data,
      host: true,
    }), {
      contentType: "application/json",
    });

    const response = await fileforge.generatePDF({
      $,
      data: formData,
      headers: formData.getHeaders(),
    });

    $.export("$summary", "Successfully generated the PDF file.");
    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
Fileforge	`fileforge`	`app`	This component uses the Fileforge app.
HTML Files	`files`	`string[]`	The HTML files to convert to PDF. Each file should be a valid path to an HTML file saved to the `/tmp` directory (e.g. `/tmp/image.png`). See the documentation..
Test	`test`	`boolean`	Generate a test document instead of a production document. The generated document will contain a watermark. Defaults to true.
Expires At	`expiresAt`	`string`	The expiration timestamp for the PDF in ISO 8601 format
Filename	`fileName`	`string`	The desired filename for the generated PDF.
Allow Viewing	`allowViewing`	`boolean`	Specifies whether viewing is allowed.