Create or Update Person with Gainsight API on Candidate Created (Instant) from Recruit CRM API

Pipedream makes it easy to connect APIs for Gainsight, Recruit CRM and 2,800+ other apps remarkably fast.

Trigger workflow on

Candidate Created (Instant) from the Recruit CRM API

Next, do this

Create or Update Person with the Gainsight 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 Recruit CRM trigger and Gainsight action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Candidate Created (Instant) trigger
1. Connect your Recruit CRM account
Configure the Create or Update Person action
1. Connect your Gainsight account
2. Configure Email
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure LinkedIn URL
6. Optional- Configure Location
7. Optional- Configure Additional Fields
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#

Candidate Created (Instant) on Recruit CRM

Description:Triggers when a new candidate is created. [See the documentation](https://docs.recruitcrm.io/docs/rcrm-api-reference/5e7ebc825ccf9-creates-a-new-subscription)

Version:0.0.1

Key:recruit_crm-candidate-created

View on GitHub

Recruit CRM Overview#

The Recruit CRM API provides a suite of functions to automate and streamline recruitment processes. It allows you to integrate your recruitment workflow with other services, create custom applications, or even build bots. With Pipedream, you can connect the Recruit CRM API to a vast array of other apps and services to automate actions like updating candidate records, syncing with HR systems, or triggering notifications based on recruitment activities.

Trigger Code#

import common from "../common/webhook.mjs";
import events from "../common/events.mjs";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  key: "recruit_crm-candidate-created",
  name: "Candidate Created (Instant)",
  description: "Triggers when a new candidate is created. [See the documentation](https://docs.recruitcrm.io/docs/rcrm-api-reference/5e7ebc825ccf9-creates-a-new-subscription)",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourcesFn() {
      return this.app.listCandidates;
    },
    getResourcesFnArgs() {
      return {
        params: {
          limit: constants.PAGINATION.LIMIT,
          sort_by: constants.PAGINATION.SORT_BY.CREATED_ON,
          sort_order: constants.PAGINATION.SORT_ORDER.DESC,
        },
      };
    },
    getEventName() {
      return events.CANDIDATE_CREATED;
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Candidate: ${resource.first_name}`,
        ts: Date.parse(resource.created_on),
      };
    },
  },
};

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
Recruit CRM	`app`	`app`	This component uses the Recruit CRM 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 Authentication#

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

To retrieve your API Token,

Navigate to your Recruit CRM account and sign in
Go to “Admin Settings” > “API & Integrations”

About Recruit CRM#

Trusted by Recruitment Agencies in 100+ countries. Recruit CRM builds cloud-based software for the global Recruitment & Staffing industry.

Action#

Create or Update Person on Gainsight

Description:Create or update a person's record. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation#Person)

Version:0.0.2

Key:gainsight_nxt-create-or-update-person

View on GitHub

Action Code#

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

export default {
  key: "gainsight_nxt-create-or-update-person",
  name: "Create or Update Person",
  description: "Create or update a person's record. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation#Person)",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    email: {
      type: "string",
      label: "Email",
      description: "The email address of the person. If a record with this email exists, it will be updated, otherwise a new one will be created.",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the person.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the person.",
      optional: true,
    },
    linkedinUrl: {
      type: "string",
      label: "LinkedIn URL",
      description: "The LinkedIn URL of the person.",
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "The location of the person.",
      optional: true,
    },
    additionalFields: {
      type: "object",
      label: "Additional Fields",
      description: "Additional fields to include in the request body. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation#Person) for all available fields.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.createOrUpdatePerson({
      $,
      data: {
        Email: this.email,
        FirstName: this.firstName,
        LastName: this.lastName,
        LinkedinUrl: this.linkedinUrl,
        Location: this.location,
        ...this.additionalFields,
      },
    });

    $.export("$summary", `Successfully upserted person with email ${this.email}`);
    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
Gainsight	`app`	`app`	This component uses the Gainsight app.
Email	`email`	`string`	The email address of the person. If a record with this email exists, it will be updated, otherwise a new one will be created.
First Name	`firstName`	`string`	The first name of the person.
Last Name	`lastName`	`string`	The last name of the person.
LinkedIn URL	`linkedinUrl`	`string`	The LinkedIn URL of the person.
Location	`location`	`string`	The location of the person.
Additional Fields	`additionalFields`	`object`	Additional fields to include in the request body. See the documentation for all available fields.