Update Employee Record with kiwiHR API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for kiwiHR, Schedule and 2,500+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Update Employee Record with the kiwiHR 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 Schedule trigger and kiwiHR action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Update Employee Record action
1. Connect your kiwiHR account
2. Select a Employee ID
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure Work Phones
6. Optional- Configure Employment Start Date
7. Optional- Configure About Me
8. Optional- Select a Gender
9. Optional- Select a Manager ID
10. Optional- Configure Nationality
11. Optional- Select one or more Team IDs
12. Optional- Select a Position ID
13. Optional- Select a Location ID
14. Optional- Configure Birth Date
15. Optional- Configure Personal Phone
16. Optional- Configure Personal Email
17. Optional- Configure Street
18. Optional- Configure City
19. Optional- Configure State
20. Optional- Configure Postal Code
21. Optional- Configure Country
22. Optional- Configure pronouns
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Update Employee Record on kiwiHR

Description:Update an existing employee's record in kiwiHR. [See the documentation](https://api.kiwihr.it/api/docs/mutation.doc.html)

Version:0.0.1

Key:kiwihr-update-employee-record

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseError } from "../../common/utils.mjs";
import kiwihr from "../../kiwihr.app.mjs";

export default {
  key: "kiwihr-update-employee-record",
  name: "Update Employee Record",
  description: "Update an existing employee's record in kiwiHR. [See the documentation](https://api.kiwihr.it/api/docs/mutation.doc.html)",
  version: "0.0.1",
  type: "action",
  props: {
    kiwihr,
    employeeId: {
      propDefinition: [
        kiwihr,
        "employeeId",
      ],
    },
    firstName: {
      propDefinition: [
        kiwihr,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        kiwihr,
        "lastName",
      ],
      optional: true,
    },
    workPhones: {
      propDefinition: [
        kiwihr,
        "workPhones",
      ],
      optional: true,
    },
    employmentStartDate: {
      propDefinition: [
        kiwihr,
        "employmentStartDate",
      ],
      optional: true,
    },
    aboutMe: {
      propDefinition: [
        kiwihr,
        "aboutMe",
      ],
      optional: true,
    },
    gender: {
      propDefinition: [
        kiwihr,
        "gender",
      ],
      optional: true,
    },
    managerId: {
      propDefinition: [
        kiwihr,
        "managerId",
      ],
      optional: true,
    },
    nationality: {
      propDefinition: [
        kiwihr,
        "nationality",
      ],
      optional: true,
    },
    teamIds: {
      propDefinition: [
        kiwihr,
        "teamIds",
      ],
      optional: true,
    },
    positionId: {
      propDefinition: [
        kiwihr,
        "positionId",
      ],
      optional: true,
    },
    locationId: {
      propDefinition: [
        kiwihr,
        "locationId",
      ],
      optional: true,
    },
    birthDate: {
      propDefinition: [
        kiwihr,
        "birthDate",
      ],
      optional: true,
    },
    personalPhone: {
      propDefinition: [
        kiwihr,
        "personalPhone",
      ],
      optional: true,
    },
    personalEmail: {
      propDefinition: [
        kiwihr,
        "personalEmail",
      ],
      optional: true,
    },
    addressStreet: {
      propDefinition: [
        kiwihr,
        "addressStreet",
      ],
      optional: true,
    },
    addressCity: {
      propDefinition: [
        kiwihr,
        "addressCity",
      ],
      optional: true,
    },
    addressState: {
      propDefinition: [
        kiwihr,
        "addressState",
      ],
      optional: true,
    },
    addressPostalCode: {
      propDefinition: [
        kiwihr,
        "addressPostalCode",
      ],
      optional: true,
    },
    addressCountry: {
      propDefinition: [
        kiwihr,
        "addressCountry",
      ],
      optional: true,
    },
    pronouns: {
      propDefinition: [
        kiwihr,
        "pronouns",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const {
        kiwihr,
        employeeId,
        addressStreet,
        addressCity,
        addressState,
        addressPostalCode,
        addressCountry,
        ...user
      } = this;

      const address = {};
      if (addressStreet) address.street = addressStreet;
      if (addressCity) address.city = addressCity;
      if (addressState) address.state = addressState;
      if (addressPostalCode) address.postalCode = addressPostalCode;
      if (addressCountry) address.country = addressCountry;

      if (Object.keys(address).length > 0) {
        user.address = address;
      }

      const response = await kiwihr.updateEmployee({
        id: employeeId,
        user,
      });

      $.export("$summary", `Successfully updated employee record for ID: ${this.employeeId}`);
      return response;
    } catch ({ response }) {
      const error = parseError(response);
      throw new ConfigurationError(error);
    }
  },
};

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
kiwiHR	`kiwihr`	`app`	This component uses the kiwiHR app.
Employee ID	`employeeId`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	The first name of the employee
Last Name	`lastName`	`string`	The last name of the employee
Work Phones	`workPhones`	`string[]`	A list of employee's work phone numbers
Employment Start Date	`employmentStartDate`	`string`	User's work started date. Format YYYY-MM-DD
About Me	`aboutMe`	`string`	Short info about the user
Gender	`gender`	`string`	Select a value from the drop down menu:`MALEFEMALEDIVERSE`
Manager ID	`managerId`	`string`	Select a value from the drop down menu.
Nationality	`nationality`	`string`	2-digit Employee's nationality in ISO 3166-1
Team IDs	`teamIds`	`string[]`	Select a value from the drop down menu.
Position ID	`positionId`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.
Birth Date	`birthDate`	`string`	Employee's date of birth
Personal Phone	`personalPhone`	`string`	Employee's personal phone number
Personal Email	`personalEmail`	`string`	Employee's personal email address
Street	`addressStreet`	`string`	The employee's street address
City	`addressCity`	`string`	The employee's city address
State	`addressState`	`string`	The employee's state address
Postal Code	`addressPostalCode`	`string`	The employee's postal code address
Country	`addressCountry`	`string`	The employee's country address
pronouns	`pronouns`	`string`	The employee's pronouns