Download Thread Attachment with Zoho Desk API

Pipedream makes it easy to connect APIs for Zoho Desk and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Download Thread Attachment with the Zoho Desk 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 Download Thread Attachment with the Zoho Desk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Download Thread Attachment action
1. Connect your Zoho Desk account
2. Select a Organization ID
3. Select a Ticket ID
4. Select a Thread ID
5. Select a Attachment ID
6. Optional- Configure Filename
7. Configure syncDir
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

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.

Download Thread Attachment on Zoho Desk

Description:Download a specific attachment belonging to a thread of a ticket. [See the documentation](https://desk.zoho.com/DeskAPIDocument#TicketAttachments_Listticketattachments)

Version:0.0.1

Key:zoho_desk-download-thread-attachment

View on GitHub

Code#

import zohoDesk from "../../zoho_desk.app.mjs";
import { Readable } from "stream";
import fs from "fs";
import { promisify } from "util";
import stream from "stream";
import { fileTypeFromBuffer } from "file-type";
import { ConfigurationError } from "@pipedream/platform";

const pipeline = promisify(stream.pipeline);

export default {
  key: "zoho_desk-download-thread-attachment",
  name: "Download Thread Attachment",
  description: "Download a specific attachment belonging to a thread of a ticket. [See the documentation](https://desk.zoho.com/DeskAPIDocument#TicketAttachments_Listticketattachments)",
  type: "action",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    zohoDesk,
    orgId: {
      propDefinition: [
        zohoDesk,
        "orgId",
      ],
    },
    ticketId: {
      propDefinition: [
        zohoDesk,
        "ticketId",
        ({ orgId }) => ({
          orgId,
        }),
      ],
    },
    threadId: {
      propDefinition: [
        zohoDesk,
        "threadId",
        ({
          orgId, ticketId,
        }) => ({
          orgId,
          ticketId,
        }),
      ],
    },
    attachmentId: {
      propDefinition: [
        zohoDesk,
        "attachmentId",
        ({
          orgId, ticketId, threadId,
        }) => ({
          orgId,
          ticketId,
          threadId,
        }),
      ],
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "The filename to save the attachment as in the /tmp directory",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  async run({ $ }) {
    const {
      orgId,
      ticketId,
      threadId,
      attachmentId,
      filename,
    } = this;

    // First, get thread details to get attachment info
    const threadResponse = await this.zohoDesk.getThreadDetails({
      $,
      ticketId,
      threadId,
      headers: {
        orgId,
      },
    });

    // Handle response structure - getThreadDetails returns { data: {...} }
    const thread = threadResponse?.data || threadResponse;
    const attachments = thread?.attachments || [];
    const attachment = attachments.find((att) => att.id === attachmentId);

    if (!attachment) {
      throw new ConfigurationError(`Attachment with ID ${attachmentId} not found in thread ${threadId}`);
    }

    // Download the attachment using the content endpoint
    const response = await this.zohoDesk.downloadThreadAttachment({
      $,
      ticketId,
      threadId,
      attachmentId,
      headers: {
        orgId,
      },
    });

    // Handle response - axios returns data in response.data when responseType is set
    const responseData = response?.data || response;
    const buffer = Buffer.from(responseData);
    const attachmentName = attachment.name || `attachment_${attachmentId}`;
    const fileName = filename || attachmentName;
    const filePath = `/tmp/${fileName}`;

    // Detect file type from buffer
    const fileType = await fileTypeFromBuffer(buffer);

    // Write file using stream pipeline (avoids fs.writeFileSync)
    const fileStream = Readable.from(buffer);
    await pipeline(fileStream, fs.createWriteStream(filePath));

    // Build metadata from attachment object and detected file type
    const metadata = {
      name: attachment.name,
      size: parseInt(attachment.size, 10),
      contentType: fileType?.mime,
      ext: fileType?.ext,
    };

    $.export("$summary", `Successfully downloaded attachment "${attachment.name}"`);

    return {
      attachmentId,
      fileName: attachment.name,
      filePath,
      size: attachment.size,
      metadata,
    };
  },
};

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
Zoho Desk	`zohoDesk`	`app`	This component uses the Zoho Desk app.
Organization ID	`orgId`	`string`	Select a value from the drop down menu.
Ticket ID	`ticketId`	`string`	Select a value from the drop down menu.
Thread ID	`threadId`	`string`	Select a value from the drop down menu.
Attachment ID	`attachmentId`	`string`	Select a value from the drop down menu.
Filename	`filename`	`string`	The filename to save the attachment as in the /tmp directory
N/A	`syncDir`	`dir`	This component uses `dir` to share files between component executions.

Authentication#

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

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

Desk.articles.CREATEDesk.articles.READDesk.articles.UPDATEDesk.basic.CREATEDesk.basic.READDesk.contacts.CREATEDesk.contacts.READDesk.contacts.UPDATEDesk.contacts.WRITEDesk.events.CREATEDesk.events.READDesk.events.UPDATEDesk.events.WRITEDesk.search.READDesk.settings.CREATEDesk.settings.READDesk.settings.UPDATEDesk.settings.WRITEDesk.tasks.CREATEDesk.tasks.READDesk.tasks.UPDATEDesk.tasks.WRITEDesk.tickets.CREATEDesk.tickets.READDesk.tickets.UPDATEDesk.tickets.WRITE