Create Candidate with CATS API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for CATS, Google Calendar and 2,700+ other apps remarkably fast.

Trigger workflow on

New Upcoming Event Alert from the Google Calendar 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 Google Calendar 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 Upcoming Event Alert trigger
1. Connect your Google Calendar account
2. Connect your Google Calendar account
3. Optional- Select a Calendar ID
4. Optional- Select one or more Event Types
5. Configure Minutes Before
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 Upcoming Event Alert on Google Calendar

Description:Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. [See the documentation](https://pipedream.com/docs/examples/waiting-to-execute-next-step-of-workflow/#step-1-create-a-task-scheduler-event-source) for more information and instructions for connecting your Pipedream account.

Version:0.0.10

Key:google_calendar-upcoming-event-alert

View on GitHub

Google Calendar Overview#

The Google Calendar API lets you dip into the powerhouse of scheduling, allowing for the reading, creation, and manipulation of events and calendars directly from your applications. Through Pipedream, you can seamlessly integrate Google Calendar into a myriad of workflows, automating event management, syncing with other services, setting up custom reminders, or even collating data for reporting. The key here is to streamline your calendar-related processes, ensuring that your time management is as efficient and automated as possible.

Trigger Code#

import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import googleCalendar from "../../google_calendar.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_calendar-upcoming-event-alert",
  name: "New Upcoming Event Alert",
  description: `Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler.
    [See the documentation](https://pipedream.com/docs/examples/waiting-to-execute-next-step-of-workflow/#step-1-create-a-task-scheduler-event-source) 
    for more information and instructions for connecting your Pipedream account.`,
  version: "0.0.10",
  type: "source",
  props: {
    pipedream: taskScheduler.props.pipedream,
    googleCalendar,
    db: "$.service.db",
    http: "$.interface.http",
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    eventTypes: {
      propDefinition: [
        googleCalendar,
        "eventTypes",
      ],
    },
    time: {
      type: "integer",
      label: "Minutes Before",
      description: "Number of minutes to trigger before the start of the calendar event.",
      min: 0,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.time > 0) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: 60 * this.time,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCalendarEventIds() {
      return this.db.get("scheduledCalendarEventIds");
    },
    _setScheduledCalendarEventIds(ids) {
      this.db.set("scheduledCalendarEventIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    subtractMinutes(date, minutes) {
      return date.getTime() - minutes * 60000;
    },
    async getCalendarEvents() {
      const calendarEvents = [];
      const params = {
        returnOnlyData: false,
        calendarId: this.calendarId,
        eventTypes: this.eventTypes,
      };
      do {
        const {
          data: {
            items, nextPageToken,
          },
        } = await this.googleCalendar.listEvents(params);
        if (items?.length) {
          calendarEvents.push(...items);
        }
        params.pageToken = nextPageToken;
      } while (params.pageToken);
      return calendarEvents;
    },
  },
  async run(event) {
    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    const scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, `Upcoming ${event.summary} event`);
      return;
    }

    // schedule new events
    const scheduledCalendarEventIds = this._getScheduledCalendarEventIds() || {};
    const calendarEvents = await this.getCalendarEvents();

    for (const calendarEvent of calendarEvents) {
      const startTime = calendarEvent.start
        ? (new Date(calendarEvent.start.dateTime || calendarEvent.start.date))
        : null;
      if (!startTime
        || startTime.getTime() < Date.now()
        || scheduledCalendarEventIds[calendarEvent.id])
      {
        continue;
      }
      const later = new Date(this.subtractMinutes(startTime, this.time));

      const scheduledEventId = this.emitScheduleEvent(calendarEvent, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCalendarEventIds[calendarEvent.id] = true;
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCalendarEventIds(scheduledCalendarEventIds);
  },
  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
Google Calendar	`pipedream`	`app`	This component uses the Google Calendar app.
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar 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.
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`defaultfocusTimeoutOfOfficeworkingLocation`
Minutes Before	`time`	`integer`	Number of minutes to trigger before the start of the calendar event.

Trigger Authentication#

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

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

https://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonlyemailprofile

About Google Calendar#

With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.

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"}

Action Authentication#

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

About CATS#

CATS Applicant Tracking System (ATS) & Recruiting Software

More Ways to Connect CATS + Google Calendar#

Other Popular Integrations#

Create Contact with CATS API on New Cancelled Event from Google Calendar API

Google Calendar + CATS

Create Candidate with CATS API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for CATS, Google Calendar and 2,700+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular