Create Employee with Personio API on New Remote Directory Watcher from SFTP (key-based auth) API

Pipedream makes it easy to connect APIs for Personio, SFTP (key-based auth) and 2,500+ other apps remarkably fast.

Trigger workflow on

New Remote Directory Watcher from the SFTP (key-based auth) 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 SFTP (key-based auth) 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 New Remote Directory Watcher trigger
1. Connect your SFTP (key-based auth) account
2. Configure timer
3. Configure Root directory
4. Configure Maximum watcher depth
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#

New Remote Directory Watcher on SFTP (key-based auth)

Description:Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)

Version:0.1.1

Key:sftp-watch-remote-directory

View on GitHub

SFTP (key-based auth) Overview#

The SFTP (key-based auth) app on Pipedream allows you to securely transfer and manage files over a network. It uses SSH for data transfer and provides the same level of security as SSH, without requiring password authentication, making automation workflows more secure and less prone to human error. You can automate file uploads, downloads, synchronization tasks, and efficiently manage your remote files in a serverless environment. Integrating this with other Pipedream-supported apps enables you to craft powerful and secure data flow systems.

Trigger Code#

import { createHash } from "crypto";
import app from "../../sftp.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "sftp-watch-remote-directory",
  name: "New Remote Directory Watcher",
  description: "Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)",
  version: "0.1.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
    rootDirectory: {
      label: "Root directory",
      description: "Root directory to be watched. example: `/public`",
      type: "string",
      default: "/",
    },
    maxDepth: {
      label: "Maximum watcher depth",
      description: "Watch all subdirectories within of the root directory, considering the selected maximum depth.",
      type: "integer",
      min: 0,
    },
  },
  methods: {
    setFiles(files) {
      this.db.set("files", files);
    },
    getFiles() {
      return this.db.get("files") || [];
    },
    getChangesWithEvent(currentFiles, previousFiles) {
      const fileChanges = [];
      // deleted file detection;
      for (const prvFile of previousFiles) {
        const file = currentFiles.find((p) => p.path === prvFile.path);
        if (!file) {
          fileChanges.push({
            ...prvFile,
            event: "deleted",
          });
        }
      }
      // created, updated file detection;
      for (const file of currentFiles) {
        const prvFile = previousFiles.find((p) => p.path === file.path);
        if (prvFile) {
          // unchanged files (checking size and last update time)
          if (prvFile.size === file.size && prvFile.modifyTime === file.modifyTime) {
            continue;
          }
          // file has changed
          fileChanges.push({
            ...file,
            event: "updated",
          });
        } else {
          // new file detection
          fileChanges.push({
            ...file,
            event: "created",
          });
        }
      }
      return fileChanges;
    },
    async listDirectories(sftp, parent, currDepth) {
      const files = await sftp.list(parent);
      return files.filter((file) => file.type === "d")
        .map((directory) => ({
          ...directory,
          parent,
          path: `${parent}/${directory.name}`,
          depth: currDepth,
        }));
    },
    async listDirectoriesDeep(sftp, parent, maxDepth, currDepth) {
      if (currDepth > maxDepth) {
        return [];
      }
      const nextDepth = currDepth + 1;
      const rootDirectories = await this.listDirectories(sftp, parent, currDepth);
      const childrenDirectories = [];
      for (const item of rootDirectories) {
        const path = `${parent}/${item.name}`;
        const directories = await this.listDirectoriesDeep(sftp, path, maxDepth, nextDepth);
        childrenDirectories.push(...directories);
      }
      rootDirectories.push(...childrenDirectories);
      return rootDirectories;
    },
    async listAllFilesFromDirectories(sftp, directories) {
      const allFiles = [];
      for (const directory of directories) {
        const listingResult = await sftp.list(directory.path);
        const files = listingResult.filter((file) => file.type !== "d")
          .map((file) => ({
            ...file,
            directory: directory.path,
            path: `${directory.path}/${file.name}`,
            depth: directory.depth || 0,
          }));
        allFiles.push(...files);
      }
      return allFiles;
    },
    validateRootDirectory(rootDirectory) {
      if (!rootDirectory) {
        throw new Error("Must provide root directory");
      }
      if (!rootDirectory.startsWith("/")) {
        throw new Error("The root directory must to be the absolute path and start with a slash, such as: '/public'");
      }
    },
    getEventId(event) {
      return createHash("md5")
        .update(event.path + event.modifyTime)
        .digest("hex");
    },
    emitEvents(events) {
      // sort events by modification time in ascending order
      events.sort((a, b) => a.modifyTime - b.modifyTime);
      for (const fileChangeEvent of events) {
        this.$emit(fileChangeEvent, {
          id: this.getEventId(fileChangeEvent),
          summary: `${fileChangeEvent.event} ${fileChangeEvent.path}`,
          ts: new Date(fileChangeEvent.modifyTime),
        });
      }
    },
  },
  async run() {
    this.validateRootDirectory(this.rootDirectory);

    const sftp = await this.app.connect();

    let directories = [
      {
        path: this.rootDirectory,
      },
    ];
    directories = directories.concat(
      await this.listDirectoriesDeep(sftp, this.rootDirectory, this.maxDepth, 0),
    );

    const currentFiles = await this.listAllFilesFromDirectories(sftp, directories);
    const previousFiles = this.getFiles();
    const filesChangesWithEvent = this.getChangesWithEvent(currentFiles, previousFiles);
    this.emitEvents(filesChangesWithEvent);

    this.setFiles(currentFiles);
    await this.app.disconnect(sftp);
  },
};

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
SFTP (key-based auth)	`app`	`app`	This component uses the SFTP (key-based auth) app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Root directory	`rootDirectory`	`string`	Root directory to be watched. example: `/public`
Maximum watcher depth	`maxDepth`	`integer`	Watch all subdirectories within of the root directory, considering the selected maximum depth.

Trigger Authentication#

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

This app holds details for an SFTP server you want to interact with in Pipedream.

Below, enter the hostname of the server you'd like to connect to, your username, and the private key you'd like to use to connect.

This app only supports key pair authentication, not authentication via password. If you need to use a username / password to connect to a host, please use the SFTP (password-based auth) app, instead.

About SFTP (key-based auth)#

Interact with an SFTP (SSH File Transfer Protocol) Server using a private key for auth

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: