Create Candidate with CATS API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for CATS, Typeform and 2,400+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Candidate with the CATS 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 Typeform trigger and CATS action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Candidate action
1. Connect your CATS account
2. Configure Check Duplicate
3. Configure First Name
4. Optional- Configure Middle Name
5. Configure Last Name
6. Optional- Configure Title
7. Optional- Configure Emails
8. Optional- Configure Phones
9. Optional- Configure Street Address
10. Optional- Configure City Address
11. Optional- Configure State Address
12. Optional- Configure Address Postal Code
13. Optional- Configure Country Code
14. Optional- Configure Social Media URLs
15. Optional- Configure Website
16. Optional- Configure Best Time to Call
17. Optional- Configure Current Employer
18. Optional- Configure Date Available
19. Optional- Configure Current Pay
20. Optional- Configure Desired Pay
21. Optional- Configure Willing to Relocate
22. Optional- Configure Key Skills
23. Optional- Configure Notes
24. Optional- Configure Source
25. Optional- Select a Owner ID
26. Optional- Configure Is Active
27. Optional- Configure Is Hot
28. Optional- Configure password
29. Optional- Select one or more Custom Fields
30. Optional- Configure Work History
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Candidate on CATS

Description:Create a new candidate in your CATS database. [See the documentation](https://docs.catsone.com/api/v3/#candidates-create-a-candidate)

Version:0.0.1

Key:cats-create-candidate

View on GitHub

Action Code#

import cats from "../../cats.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "cats-create-candidate",
  name: "Create Candidate",
  description: "Create a new candidate in your CATS database. [See the documentation](https://docs.catsone.com/api/v3/#candidates-create-a-candidate)",
  version: "0.0.1",
  type: "action",
  props: {
    cats,
    checkDuplicate: {
      propDefinition: [
        cats,
        "checkDuplicate",
      ],
    },
    firstName: {
      propDefinition: [
        cats,
        "firstName",
      ],
    },
    middleName: {
      propDefinition: [
        cats,
        "middleName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        cats,
        "lastName",
      ],
    },
    title: {
      propDefinition: [
        cats,
        "title",
      ],
      optional: true,
    },
    emails: {
      propDefinition: [
        cats,
        "emails",
      ],
      optional: true,
    },
    phones: {
      propDefinition: [
        cats,
        "phones",
      ],
      optional: true,
    },
    addressStreet: {
      propDefinition: [
        cats,
        "addressStreet",
      ],
      optional: true,
    },
    addressCity: {
      propDefinition: [
        cats,
        "addressCity",
      ],
      optional: true,
    },
    addressState: {
      propDefinition: [
        cats,
        "addressState",
      ],
      optional: true,
    },
    addressPostalCode: {
      propDefinition: [
        cats,
        "addressPostalCode",
      ],
      optional: true,
    },
    countryCode: {
      propDefinition: [
        cats,
        "countryCode",
      ],
      optional: true,
    },
    socialMediaUrls: {
      propDefinition: [
        cats,
        "socialMediaUrls",
      ],
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "The website of the record.",
      optional: true,
    },
    bestTimeToCall: {
      propDefinition: [
        cats,
        "bestTimeToCall",
      ],
      optional: true,
    },
    currentEmployer: {
      propDefinition: [
        cats,
        "currentEmployer",
      ],
      optional: true,
    },
    dateAvailable: {
      type: "string",
      label: "Date Available",
      description: "The date the record is available for an opening. **Format: YYYY-MM-DD**.",
      optional: true,
    },
    currentPay: {
      type: "string",
      label: "Current Pay",
      description: "The current pay of the record.",
      optional: true,
    },
    desiredPay: {
      propDefinition: [
        cats,
        "desiredPay",
      ],
      optional: true,
    },
    isWillingToRelocate: {
      propDefinition: [
        cats,
        "isWillingToRelocate",
      ],
      optional: true,
    },
    keySkills: {
      propDefinition: [
        cats,
        "keySkills",
      ],
      optional: true,
    },
    notes: {
      propDefinition: [
        cats,
        "notes",
      ],
      optional: true,
    },
    source: {
      propDefinition: [
        cats,
        "source",
      ],
      optional: true,
    },
    ownerId: {
      propDefinition: [
        cats,
        "ownerId",
      ],
      optional: true,
    },
    isActive: {
      type: "boolean",
      label: "Is Active",
      description: "A flag indicating if the candidate is active.",
      optional: true,
    },
    isHot: {
      propDefinition: [
        cats,
        "isHot",
      ],
      optional: true,
    },
    password: {
      type: "string",
      label: "password",
      description: "The candidate's password if they are \"registering\".",
      secret: true,
      optional: true,
    },
    customFields: {
      propDefinition: [
        cats,
        "customFields",
      ],
      withLabel: true,
      reloadProps: true,
      optional: true,
    },
    workHistory: {
      propDefinition: [
        cats,
        "workHistory",
      ],
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    (this.customFields || []).map(({
      label, value,
    }) => {
      props[value] = {
        type: "string",
        label: `Custom Field: ${label}`,
        optional: true,
      };
    }, {});

    return props;
  },
  async run({ $ }) {
    const {
      cats, // eslint-disable-next-line no-unused-vars
      customFields,
      firstName,
      lastName,
      ownerId,
      middleName,
      checkDuplicate,
      bestTimeToCall,
      currentEmployer,
      emails,
      phones,
      addressStreet,
      addressCity,
      addressState,
      addressPostalCode,
      countryCode,
      socialMediaUrls,
      dateAvailable,
      currentPay,
      desiredPay,
      isWillingToRelocate,
      keySkills,
      isActive,
      isHot,
      workHistory,
      ...data
    } = this;

    const customFieldsObject = customFields
      ? customFields.map(({ value }) => {
        return {
          id: value,
          value: data[value],
        };
      })
      : {};

    const { headers } = await cats.createCandidate({
      $,
      returnFullResponse: true,
      params: {
        check_duplicate: checkDuplicate,
      },
      data: {
        first_name: firstName,
        middle_name: middleName,
        last_name: lastName,
        emails: parseObject(emails),
        phones: parseObject(phones),
        address: {
          street: addressStreet,
          city: addressCity,
          state: addressState,
          postal_code: addressPostalCode,
        },
        country_code: countryCode,
        social_media_urls: parseObject(socialMediaUrls),
        best_time_to_call: bestTimeToCall,
        current_employer: currentEmployer,
        date_available: dateAvailable,
        current_pay: currentPay,
        desired_pay: desiredPay,
        is_willing_to_relocate: isWillingToRelocate,
        key_skills: keySkills,
        owner_id: ownerId,
        is_active: isActive,
        is_hot: isHot,
        work_history: parseObject(workHistory),
        custom_fields: customFieldsObject,
        ...data,
      },
    });

    const location = headers.location.split("/");
    const candidateId = location[location.length - 1];

    $.export("$summary", `Created candidate with ID ${candidateId}`);
    return {
      candidateId,
    };
  },
};

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
CATS	`cats`	`app`	This component uses the CATS app.
Check Duplicate	`checkDuplicate`	`boolean`	When this flag is set to true, if a duplicate record is found to the one being created, an error will be thrown instead of creating a duplicate record.
First Name	`firstName`	`string`	The first name of the record.
Middle Name	`middleName`	`string`	The middle name of the record.
Last Name	`lastName`	`string`	The last name of the record.
Title	`title`	`string`	The record's job title.
Emails	`emails`	`string[]`	An array of email objects. Each email object should contain two keys: `email` and `is_primary`, as described here. Format: {"email":"example@email.com", "is_primary":"true"}
Phones	`phones`	`string[]`	An array of phone objects. Each phone object should contain three keys: `number`, `extension`, and `type`, as described here. Format: {"number":"+16124063451", "extension":"8371", "type":"mobile"}. Type can be `mobile`, `home`, `work`, `fax`, `main` or `other`
Street Address	`addressStreet`	`string`	The street of the record's address.
City Address	`addressCity`	`string`	The city of the record's address.
State Address	`addressState`	`string`	The state of the record's address.
Address Postal Code	`addressPostalCode`	`string`	The postal code of the record's address.
Country Code	`countryCode`	`string`	The country code of the record.
Social Media URLs	`socialMediaUrls`	`string[]`	The social media URLs of the record.
Website	`website`	`string`	The website of the record.
Best Time to Call	`bestTimeToCall`	`string`	The best time to call the record. Format: HH:MM.
Current Employer	`currentEmployer`	`string`	The current employer of the record.
Date Available	`dateAvailable`	`string`	The date the record is available for an opening. Format: YYYY-MM-DD.
Current Pay	`currentPay`	`string`	The current pay of the record.
Desired Pay	`desiredPay`	`string`	The desired pay for the record.
Willing to Relocate	`isWillingToRelocate`	`boolean`	Whether the record is willing to relocate.
Key Skills	`keySkills`	`string`	The key skills of the record.
Notes	`notes`	`string`	Any notes about the record.
Source	`source`	`string`	The source of the record.
Owner ID	`ownerId`	`integer`	Select a value from the drop down menu.
Is Active	`isActive`	`boolean`	A flag indicating if the candidate is active.
Is Hot	`isHot`	`boolean`	Whether the record is marked as hot.
password	`password`	`string`	The candidate's password if they are "registering".
Custom Fields	`customFields`	`string[]`	Select a value from the drop down menu.
Work History	`workHistory`	`string[]`	An array of work history objects. Example: {"title": "Engineer", "employer": { "linked": false, "name": "<employer name>", "location": { "city": "<employer city>", "state": "<employer state>" }}, "supervisor": { "linked": false, "name": "<supervisor name>", "phone": "<supervisor phone number>" }, "is_verified": true, "is_current": false, "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD", "reason_for_leaving": "foo"}