Create Employee with Personio API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Employee with the Personio 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 Personio 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 Create Employee action
1. Connect your Personio account
2. Configure Email
3. Configure First Name
4. Configure Last Name
5. Optional- Configure Gender
6. Optional- Configure Position
7. Optional- Configure Subcompany
8. Optional- Configure Department
9. Optional- Configure Office
10. Optional- Configure Hire Date
11. Optional- Configure Weekly Working Hours
12. Optional- Select a Status
13. Optional- Select a Supervisor Id
14. Optional- Configure Custom Attributes
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#

Create Employee on Personio

Description:Creates a new employee. [See the documentation](https://developer.personio.de/reference/post_company-employees)

Version:0.0.1

Key:personio-create-employee

View on GitHub

Personio Overview#

The Personio API provides programmatic access to HR management functions, allowing you to manage employee data, time tracking, payroll, and recruitment processes. With Pipedream, you can leverage this API to create automations and workflows that can streamline HR operations, react to events in Personio in real-time, and connect HR data to other systems seamlessly.

Action Code#

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

export default {
  key: "personio-create-employee",
  name: "Create Employee",
  version: "0.0.1",
  description: "Creates a new employee. [See the documentation](https://developer.personio.de/reference/post_company-employees)",
  type: "action",
  props: {
    personio,
    email: {
      propDefinition: [
        personio,
        "email",
      ],
    },
    firstName: {
      propDefinition: [
        personio,
        "firstName",
      ],
    },
    lastName: {
      propDefinition: [
        personio,
        "lastName",
      ],
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "The gender of the employee.",
      optional: true,
    },
    position: {
      type: "string",
      label: "Position",
      description: "The position of the employee. E.g. **developer**.",
      optional: true,
    },
    subcompany: {
      type: "string",
      label: "Subcompany",
      description: "The subcompany employee belongs to. Should be predefined in Personio. Otherwise will be ignored with showing meta error in the response.",
      optional: true,
    },
    department: {
      type: "string",
      label: "Department",
      description: "The department employee belongs to. Should be predefined in Personio. Otherwise will be ignored with showing meta error in the response.",
      optional: true,
    },
    office: {
      type: "string",
      label: "Office",
      description: "The office employee belongs to. Should be predefined in Personio. Otherwise will be ignored with showing meta error in the response.",
      optional: true,
    },
    hireDate: {
      type: "string",
      label: "Hire Date",
      description: "Employee hire date. Format: \"yyyy-mm-dd\". If `status` is not provided, it will be set to `active` if the hire date is in the past, or to `onboarding` if it's in the future.",
      optional: true,
    },
    weeklyWorkingHours: {
      type: "integer",
      label: "Weekly Working Hours",
      description: "All hours usually worked, including regular overtime.",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Status of the employee. Overrides the status determined based on the value of `hire_date`.",
      options: [
        "onboarding",
        "active",
        "leave",
        "inactive",
      ],
      optional: true,
    },
    supervisorId: {
      propDefinition: [
        personio,
        "supervisorId",
      ],
      optional: true,
    },
    customAttributes: {
      type: "object",
      label: "Custom Attributes",
      description: "Additional attributes to the employee.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      personio,
      firstName,
      lastName,
      hireDate,
      weeklyWorkingHours,
      supervisorId,
      customAttributes,
      ...data
    } = this;

    const response = await personio.createEmployee({
      $,
      data: {
        employee: {
          first_name: firstName,
          last_name: lastName,
          hire_date: hireDate,
          weekly_working_hours: weeklyWorkingHours,
          supervisor_id: supervisorId,
          custom_attributes: customAttributes,
          ...data,
        },
      },
    });

    $.export("$summary", `A new employee with Id: ${response.data?.id} was successfully created!`);
    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
Personio	`personio`	`app`	This component uses the Personio app.
Email	`email`	`string`	The e-mail field is required for the employee creation. Updating of this field is not currently supported.
First Name	`firstName`	`string`	The first name of the employee.
Last Name	`lastName`	`string`	The last name of the employee.
Gender	`gender`	`string`	The gender of the employee.
Position	`position`	`string`	The position of the employee. E.g. developer.
Subcompany	`subcompany`	`string`	The subcompany employee belongs to. Should be predefined in Personio. Otherwise will be ignored with showing meta error in the response.
Department	`department`	`string`	The department employee belongs to. Should be predefined in Personio. Otherwise will be ignored with showing meta error in the response.
Office	`office`	`string`	The office employee belongs to. Should be predefined in Personio. Otherwise will be ignored with showing meta error in the response.
Hire Date	`hireDate`	`string`	Employee hire date. Format: "yyyy-mm-dd". If `status` is not provided, it will be set to `active` if the hire date is in the past, or to `onboarding` if it's in the future.
Weekly Working Hours	`weeklyWorkingHours`	`integer`	All hours usually worked, including regular overtime.
Status	`status`	`string`	Select a value from the drop down menu:`onboardingactiveleaveinactive`
Supervisor Id	`supervisorId`	`string`	Select a value from the drop down menu.
Custom Attributes	`customAttributes`	`object`	Additional attributes to the employee.

Action Authentication#

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

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