Add Person Address with Clockwork Recruiting API on New Candidate Application from Greenhouse API

Pipedream makes it easy to connect APIs for Clockwork Recruiting, Greenhouse and 3,000+ other apps remarkably fast.

Trigger workflow on

New Candidate Application from the Greenhouse API

Next, do this

Add Person Address with the Clockwork Recruiting 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 Greenhouse trigger and Clockwork Recruiting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Candidate Application trigger
1. Connect your Greenhouse account
2. Configure timer
Configure the Add Person Address action
1. Connect your Clockwork Recruiting account
2. Select a Person Id
3. Configure City
4. Optional- Configure Country
5. Optional- Configure Postal Code
6. Configure State
7. Optional- Configure Street
8. Optional- Configure Street 2
9. Optional- Configure Location
10. Optional- Select a Region Id
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#

New Candidate Application on Greenhouse

Description:Emit new event when a candidate submits a new application.

Version:0.0.1

Key:greenhouse-new-candidate-application

View on GitHub

Greenhouse Overview#

The Greenhouse API offers a powerful suite of tools for automating and enhancing the recruitment process. It allows you to programmatically access candidate information, job listings, scorecards, and scheduling details, which opens a myriad of possibilities for streamlining recruiting workflows. By leveraging the Greenhouse API on Pipedream, you can automate repetitive tasks, integrate with other HR systems, analyze recruitment data, and build custom event-driven workflows to improve the efficiency and effectiveness of your hiring process.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import greenhouse from "../../greenhouse.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "greenhouse-new-candidate-application",
  name: "New Candidate Application",
  description: "Emit new event when a candidate submits a new application.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    greenhouse,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || "1970-01-01";
    },
    _setLastDate(created) {
      this.db.set("lastDate", created);
    },
    generateMeta(item) {
      return {
        id: item.id,
        summary: `New candidate application with Id: ${item.id}`,
        ts: new Date(),
      };
    },
    async startEvent(maxResults) {
      const lastDate = this._getLastDate();
      const response = this.greenhouse.paginate({
        fn: this.greenhouse.listApplications,
        params: {
          created_after: lastDate,
        },
      });

      let responseArray = [];
      for await (const item of response) {
        responseArray.push(item);
      }

      responseArray = responseArray.reverse();

      if (responseArray.length) {
        if (responseArray.length > maxResults) {
          responseArray.length = maxResults;
        }
        this._setLastDate(responseArray[0].applied_at);
      }

      for (const item of responseArray.reverse()) {
        this.$emit(item, this.generateMeta(item));
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
Greenhouse	`greenhouse`	`app`	This component uses the Greenhouse app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger 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

About Greenhouse#

Talent Acquisition suite built for structured hiring

Action#

Add Person Address on Clockwork Recruiting

Description:Create an address to a specific person. [See the documentation](https://app.swaggerhub.com/apis-docs/clockwork-recruiting/cw-public-api/3.0.0#/Person%20Addresses/post_people__person_id__addresses)

Version:0.0.2

Key:clockwork_recruiting-add-person-address

View on GitHub

Clockwork Recruiting Overview#

The Clockwork Recruiting API offers a suite of features tailored for executive search firms and in-house recruiting teams, enabling users to manage candidates, clients, and search projects with ease. By integrating this API with Pipedream, you can automate the recruitment process, sync data between various platforms, and streamline candidate engagement and tracking. Pipedream's serverless platform facilitates the creation of custom workflows using the Clockwork Recruiting API to optimize recruitment operations without manual intervention.

Action Code#

import app from "../../clockwork_recruiting.app.mjs";

export default {
  key: "clockwork_recruiting-add-person-address",
  name: "Add Person Address",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  description: "Create an address to a specific person. [See the documentation](https://app.swaggerhub.com/apis-docs/clockwork-recruiting/cw-public-api/3.0.0#/Person%20Addresses/post_people__person_id__addresses)",
  type: "action",
  props: {
    app,
    personId: {
      propDefinition: [
        app,
        "personId",
      ],
    },
    city: {
      type: "string",
      label: "City",
      description: "The address' city.",
    },
    country: {
      type: "string",
      label: "Country",
      description: "The address' country.",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "The address' postal code.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "The address' state.",
    },
    street: {
      type: "string",
      label: "Street",
      description: "The address' street.",
      optional: true,
    },
    street2: {
      type: "string",
      label: "Street 2",
      description: "The address' street 2.",
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "The address' type.",
      optional: true,
    },
    regionId: {
      propDefinition: [
        app,
        "regionId",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      personId,
      regionId,
      street2,
      ...data
    } = this;

    const response = await app.createAddress({
      $,
      personId,
      data: {
        address: {
          ...data,
          region_id: regionId,
          street_2: street2,
        },
      },
    });

    $.export("$summary", `Successfully created new address with ID ${response.personAddress?.id}`);
    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
Clockwork Recruiting	`app`	`app`	This component uses the Clockwork Recruiting app.
Person Id	`personId`	`string`	Select a value from the drop down menu.
City	`city`	`string`	The address' city.
Country	`country`	`string`	The address' country.
Postal Code	`postalCode`	`string`	The address' postal code.
State	`state`	`string`	The address' state.
Street	`street`	`string`	The address' street.
Street 2	`street2`	`string`	The address' street 2.
Location	`location`	`string`	The address' type.
Region Id	`regionId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API Key, API Secret, and Firm Service Key