Add Attachment To Bug with Zoho BugTracker API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Add Attachment To Bug action
1. Connect your Zoho BugTracker account
2. Select a Portal ID
3. Select a Project ID
4. Select a Bug ID
5. Configure Upload Doc File Path or URL
6. Optional- 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.

Add Attachment To Bug on Zoho BugTracker

Description:Adds an attachment to a bug. [See the documentation](https://projects.zoho.com/api-docs#issue-attachment#associate-attachments)

Version:0.0.1

Key:zoho_bugtracker-add-attachment-to-bug

View on GitHub

Code#

import zohoBugtracker from "../../zoho_bugtracker.app.mjs";
import { getFileStreamAndMetadata } from "@pipedream/platform";
import FormData from "form-data";

export default {
  key: "zoho_bugtracker-add-attachment-to-bug",
  name: "Add Attachment To Bug",
  description: "Adds an attachment to a bug. [See the documentation](https://projects.zoho.com/api-docs#issue-attachment#associate-attachments)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    zohoBugtracker,
    portalId: {
      propDefinition: [
        zohoBugtracker,
        "portalId",
      ],
    },
    projectId: {
      propDefinition: [
        zohoBugtracker,
        "projectId",
        ({ portalId }) => ({
          portalId,
        }),
      ],
    },
    bugId: {
      propDefinition: [
        zohoBugtracker,
        "bugId",
        ({
          portalId, projectId,
        }) => ({
          portalId,
          projectId,
        }),
      ],
    },
    uploaddoc: {
      propDefinition: [
        zohoBugtracker,
        "uploaddoc",
      ],
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const form = new FormData();
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(this.uploaddoc);

    form.append("upload_file", stream, {
      contentType: metadata.contentType,
      knownLength: metadata.size,
      filename: metadata.name,
    });

    form.append("attachment_details[storage_type]", "WorkDrive");
    form.append("attachment_details[location_details][project_id]", this.projectId);

    const { attachment } = await this.zohoBugtracker.uploadGlobalAttachment({
      $,
      portalId: this.portalId,
      data: form,
      headers: form.getHeaders(),
    });
    const id = attachment[0].attachment_id;

    const form2 = new FormData();
    form2.append("attachment_ids", JSON.stringify([
      id,
    ]));

    const response = await this.zohoBugtracker.addAttachmentToIssue({
      $,
      portalId: this.portalId,
      projectId: this.projectId,
      bugId: this.bugId,
      data: form2,
      headers: form2.getHeaders(),
    });

    $.export("$summary", `Successfully uploaded attachment to bug ${this.bugId}`);
    return response;
  },
};

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 BugTracker	`zohoBugtracker`	`app`	This component uses the Zoho BugTracker app.
Portal ID	`portalId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Bug ID	`bugId`	`string`	Select a value from the drop down menu.
Upload Doc File Path or URL	`uploaddoc`	`string`	The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`. Please configure Zoho Drive integration to enable attachment for your Zoho BugTracker. The maximum size to upload a file is 128 MB.
N/A	`syncDir`	`dir`	This component uses `dir` to share files between component executions.

Authentication#

Zoho BugTracker uses OAuth authentication. When you connect your Zoho BugTracker account, Pipedream will open a popup window where you can sign into Zoho BugTracker 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 BugTracker API.

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

ZohoBugTracker.bugs.READZohoBugTracker.bugs.CREATEZohoBugTracker.bugs.UPDATEZohoBugTracker.projects.READZohoBugTracker.users.READZohoBugTracker.portals.READZohoProjects.portals.READZohoBugTracker.milestones.READZohoProjects.bugs.READZohoProjects.bugs.CREATEZohoProjects.bugs.UPDATEZohoProjects.users.READZohoProjects.custom_fields.READZohoProjects.portals.CREATEWorkDrive.workspace.ALLWorkDrive.files.ALL