Add Attachment to Candidate with Greenhouse API

Pipedream makes it easy to connect APIs for Greenhouse and 2,200+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Add Attachment to Candidate action
1. Connect your Greenhouse account
2. Select a User Id
3. Select a Candidate ID
4. Configure Filename
5. Select a Type
6. Optional- Configure File
7. Optional- Configure URL
8. Optional- Select a Content Type
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

Integrations#

Add Attachment to Candidate with Greenhouse API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Greenhouse

Try it

Add Attachment to Candidate with Greenhouse API on New Submission from Typeform API

Typeform + Greenhouse

Try it

Add Attachment to Candidate with Greenhouse API on New Submission (Instant) from Jotform API

Jotform + Greenhouse

Try it

Add Attachment to Candidate with Greenhouse API on New Scheduled Tasks from Pipedream API

Pipedream + Greenhouse

Try it

Add Attachment to Candidate with Greenhouse API on npm Download Counts from npm API

npm + Greenhouse

Try it

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 Candidate on Greenhouse

Description:Adds an attachment to a specific candidate or prospect. [See the documentation](https://developers.greenhouse.io/harvest.html#post-add-attachment)

Version:0.0.1

Key:greenhouse-add-attachment-to-candidate

View on GitHub

Code#

import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import { CONTENT_TYPE_OPTIONS } from "../../common/constants.mjs";
import { checkTmp } from "../../common/utils.mjs";
import greenhouse from "../../greenhouse.app.mjs";

export default {
  key: "greenhouse-add-attachment-to-candidate",
  name: "Add Attachment to Candidate",
  description: "Adds an attachment to a specific candidate or prospect. [See the documentation](https://developers.greenhouse.io/harvest.html#post-add-attachment)",
  version: "0.0.1",
  type: "action",
  props: {
    greenhouse,
    userId: {
      propDefinition: [
        greenhouse,
        "userId",
      ],
    },
    candidateId: {
      propDefinition: [
        greenhouse,
        "candidateId",
      ],
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "Name of the file.",
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the file.",
      options: [
        "resume",
        "cover_letter",
        "admin_only",
      ],
    },
    file: {
      type: "string",
      label: "File",
      description: "The path to the image file saved to the `/tmp` directory (e.g. `/tmp/example.jpg`). [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory). (if you are providing content, you do not need to provide url).",
      optional: true,
    },
    url: {
      type: "string",
      label: "URL",
      description: "Url of the attachment (if you are providing the url, you do not need to provide the content.) *Please note, shareable links from cloud services such as Google Drive will result in a corrupted file. Please use machine accessbile URLs*.",
      optional: true,
    },
    contentType: {
      type: "string",
      label: "Content Type",
      description: "The content-type of the document you are sending. When using a URL, this generally isn't needed, as the responding server will deliver a content type. This should be included for encoded content.",
      optional: true,
      options: CONTENT_TYPE_OPTIONS,
    },
  },
  async run({ $ }) {
    if ((this.file && this.url) || (!this.file && !this.url)) {
      throw new ConfigurationError("You must provide either File or URL");
    }

    let encodedFile;

    if (this.file) {
      if (!this.contentType) {
        throw new ConfigurationError("You must provide the Content-Type");
      }
      const file = fs.readFileSync(checkTmp(this.file));
      encodedFile = Buffer(file).toString("base64");
    }

    const response = await this.greenhouse.addAttachmentToCandidate({
      $,
      headers: {
        "On-Behalf-Of": this.userId,
      },
      candidateId: this.candidateId,
      data: {
        filename: this.filename,
        type: this.type,
        content: encodedFile,
        url: this.url,
        content_type: this.contentType,
      },
    });

    $.export("$summary", `Successfully added attachment to candidate ${this.candidateId}`);
    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
Greenhouse	`greenhouse`	`app`	This component uses the Greenhouse app.
User Id	`userId`	`string`	Select a value from the drop down menu.
Candidate ID	`candidateId`	`string`	Select a value from the drop down menu.
Filename	`filename`	`string`	Name of the file.
Type	`type`	`string`	Select a value from the drop down menu:`resumecover_letteradmin_only`
File	`file`	`string`	The path to the image file saved to the `/tmp` directory (e.g. `/tmp/example.jpg`). See the documentation. (if you are providing content, you do not need to provide url).
URL	`url`	`string`	Url of the attachment (if you are providing the url, you do not need to provide the content.) Please note, shareable links from cloud services such as Google Drive will result in a corrupted file. Please use machine accessbile URLs.
Content Type	`contentType`	`string`	Select a value from the drop down menu:`application/atom+xmlapplication/javascriptapplication/jsonapplication/msgpackapplication/mswordapplication/pdfapplication/rss+xmlapplication/vnd.ms-excelapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.ms-powerpointapplication/xmlapplication/x-www-form-urlencodedapplication/x-yamlapplication/zipmultipart/form-dataimage/bmpimage/gifimage/jpegimage/pngimage/tifftext/calendartext/csstext/csvtext/htmltext/javascripttext/plaintext/vcardvideo/mpeg`

Authentication#

Greenhouse uses API keys for authentication. When you connect your Greenhouse account, Pipedream securely stores the keys so you can easily authenticate to Greenhouse APIs in both code and no-code steps.

In order to create a Harvest API key, a user must be granted the “Can manage ALL organization’s API Credentials” in the “Developer permission” section. That user can then go Configure >> Dev Center >> API Credential Management as described in Harvest API Introduction.