Create Application with Personio API on Transfer Payment Updated from Ramp API

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

Trigger workflow on

Transfer Payment Updated from the Ramp API

Next, do this

Create Application 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 Ramp 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 Transfer Payment Updated trigger
1. Connect your Ramp account
2. Configure timer
3. Optional- Select a Status
Configure the Create Application action
1. Connect your Personio account
2. Configure Company Id
3. Configure Recruiting Access Token
4. Configure First Name
5. Configure Last Name
6. Configure Email
7. Configure Job Position Id
8. Optional- Configure Recruiting Channel Id
9. Optional- Configure External Posting Id
10. Optional- Configure Message
11. Optional- Configure Application Date
12. Optional- Configure Tags
13. Optional- Configure Files
14. Optional- Configure Attributes
15. Optional- Select a Phase Type
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#

Transfer Payment Updated on Ramp

Description:Emit new event when the status of a transfer payment changes

Version:0.0.2

Key:ramp-transfer-payment-updated

View on GitHub

Ramp Overview#

The Ramp API provides programmatic access to financial and accounting functionalities, allowing for the management of company cards, transactions, and reporting. By leveraging the Ramp API within Pipedream, you can automate intricate finance operations, synchronize transaction data with accounting software, trigger notifications based on spending activities, and analyze financial data in real-time, integrating with other services for enhanced financial workflows.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "ramp-transfer-payment-updated",
  name: "Transfer Payment Updated",
  description: "Emit new event when the status of a transfer payment changes",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    transferStatus: {
      propDefinition: [
        common.props.ramp,
        "transferStatus",
      ],
    },
  },
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.ramp.listTransfers;
    },
    getParams() {
      return {
        status: this.transferStatus,
      };
    },
    generateMeta(transfer) {
      const ts = Date.now();
      return {
        id: `${transfer.id}-${ts}`,
        summary: `Status updated for transfer ID: ${transfer.id}`,
        ts,
      };
    },
    emitResults(results, max) {
      const previousStatuses = this._getPreviousStatuses();
      let transfers = [];
      for (const transfer of results) {
        if (previousStatuses[transfer.id] && previousStatuses[transfer.id] !== transfer.status) {
          transfers.push(transfer);
        }
        previousStatuses[transfer.id] = transfer.status;
      }
      this._setPreviousStatuses(previousStatuses);
      if (!transfers.length) {
        return;
      }
      if (max && transfers.length > max) {
        transfers = transfers.slice(-1 * max);
      }
      transfers.reverse().forEach((transfer) => {
        const meta = this.generateMeta(transfer);
        this.$emit(transfer, meta);
      });
    },
  },
  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
Ramp	`ramp`	`app`	This component uses the Ramp app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Status	`transferStatus`	`string`	Select a value from the drop down menu:`ACH_CONFIRMEDCANCELEDCOMPLETEDERRORINITIATEDNOT_ACKEDNOT_ENOUGH_FUNDSPROCESSING_BY_ODFIREJECTED_BY_ODFIRETURNED_BY_RDFISUBMITTED_TO_FEDSUBMITTED_TO_RDFIUNNECESSARYUPLOADED`

Trigger Authentication#

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

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

transactions:readcards:readcards:writespend_programs:readspend_programs:writeusers:readusers:writelocations:readlocations:writelimits:readlimits:writedepartments:readdepartments:writebusiness:readreceipts:readtransfers:readvendors:readmerchants:readaccounting:readreceipts:write

About Ramp#

The Corporate Card That Helps You Spend Less

Action#

Create Application on Personio

Description:Creates a new application. [See the documentation](https://developer.personio.de/reference/post_v1-recruiting-applications)

Version:0.0.1

Key:personio-create-application

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 {
  parseArray,
  toSingleLineString,
} from "../../common/utils.mjs";
import personio from "../../personio.app.mjs";

export default {
  key: "personio-create-application",
  name: "Create Application",
  version: "0.0.1",
  description: "Creates a new application. [See the documentation](https://developer.personio.de/reference/post_v1-recruiting-applications)",
  type: "action",
  props: {
    personio,
    companyId: {
      type: "string",
      label: "Company Id",
      description: "Your company id provided at https://{YOUR_COMPANY}.personio.de/configuration/api/credentials/management",
    },
    recruitingAccessToken: {
      type: "string",
      label: "Recruiting Access Token",
      description: "Your recruiting access Token provided at https://{YOUR_COMPANY}.personio.de/configuration/api/credentials/management",
      secret: true,
    },
    firstName: {
      propDefinition: [
        personio,
        "firstName",
      ],
      description: "First name(s) of the applicant. Must not be empty or only whitespaces.",
    },
    lastName: {
      propDefinition: [
        personio,
        "lastName",
      ],
      description: "Last name(s) of the applicant. Must not be empty or only whitespaces.",
    },
    email: {
      propDefinition: [
        personio,
        "email",
      ],
      description: "Email address of the applicant.",
    },
    jobPositionId: {
      type: "integer",
      label: "Job Position Id",
      description: toSingleLineString(
        `The personio internal id of the job this application should belong to.
        Access your positions page at https://{YOUR_COMPANY}.personio.de/recruiting/positions; Select a position;
        If your current URL is https://{YOUR_COMPANY}.personio.de/recruiting/positions/12345, then your Job Position ID is \`12345\``,
      ),
    },
    recruitingChannelId: {
      type: "string",
      label: "Recruiting Channel Id",
      description: "The recruiting channel this application was sourced from. See https://{YOUR_COMPANY}.personio.de/configuration/recruiting/channels.",
      optional: true,
    },
    externalPostingId: {
      type: "string",
      label: "External Posting Id",
      description: "The external id of the job posting (E.g. the external id forwarded by Gohiring).",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The applicant supplied free-text message.",
      optional: true,
    },
    applicationDate: {
      type: "string",
      label: "Application Date",
      description: "The application date (yyyy-mm-dd). It cannot be a date in the future.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Tags to be associated with this application. Non-existing tags will be created. See https://{YOUR_COMPANY}.personio.de/configuration/recruiting/tags.",
      optional: true,
    },
    files: {
      type: "string[]",
      label: "Files",
      description: "A list of references to previously updated files. These will be attached to the new application. Each file item consists of an uuid, an original_filename and a category. [See the documentation](https://developer.personio.de/reference/post_v1-recruiting-applications).",
      optional: true,
    },
    attributes: {
      type: "string[]",
      label: "Attributes",
      description: "A list of attributes for this applicant. Each attribute item consists of an id and a value. [See the documentation](https://developer.personio.de/reference/post_v1-recruiting-applications).",
      optional: true,
    },
    phaseType: {
      type: "string",
      label: "Phase Type",
      description: "The type of application phase.",
      options: [
        "system",
        "custom",
      ],
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.phaseType) {
      props.phaseId = (this.phaseType === "system")
        ? {
          type: "string",
          label: "Phase Id",
          description: "The Id of the phase.",
          options: [
            "unassigned",
            "rejected",
            "withdrawn",
            "offer",
            "accepted",
          ],
        }
        : {
          type: "string",
          label: "Phase Id",
          description: "The Id for your custom phase can be found under your personio settings (https://{YOUR_COMPANY}.personio.de/configuration/recruiting/phases).",
          default: "",
        };
    }
    return props;
  },
  async run({ $ }) {
    const {
      personio,
      companyId,
      recruitingAccessToken,
      firstName,
      lastName,
      jobPositionId,
      recruitingChannelId,
      externalPostingId,
      applicationDate,
      phaseType,
      phaseId,
      tags,
      files,
      attributes,
      ...data
    } = this;

    const phase = {};
    if (phaseType) phase.type = phaseType;
    if (phaseId) phase.id = phaseId;

    const info = {
      first_name: firstName,
      last_name: lastName,
      job_position_id: jobPositionId,
      recruiting_channel_id: recruitingChannelId,
      external_posting_id: externalPostingId,
      application_date: applicationDate,
      tags: parseArray(tags),
      files: parseArray(files),
      attributes: parseArray(attributes),
      ...data,
    };

    if (Object.entries(phase).length) {
      info.phase = phase;
    }

    const response = await personio.createApplication({
      $,
      headers: {
        "X-Company-Id": companyId,
        "Authorization": `Bearer ${recruitingAccessToken}`,
      },
      data: info,
    });

    $.export("$summary", "A new application 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.
Company Id	`companyId`	`string`	Your company id provided at https://{YOUR_COMPANY}.personio.de/configuration/api/credentials/management
Recruiting Access Token	`recruitingAccessToken`	`string`	Your recruiting access Token provided at https://{YOUR_COMPANY}.personio.de/configuration/api/credentials/management
First Name	`firstName`	`string`	First name(s) of the applicant. Must not be empty or only whitespaces.
Last Name	`lastName`	`string`	Last name(s) of the applicant. Must not be empty or only whitespaces.
Email	`email`	`string`	Email address of the applicant.
Job Position Id	`jobPositionId`	`integer`	The personio internal id of the job this application should belong to. Access your positions page at https://{YOUR_COMPANY}.personio.de/recruiting/positions; Select a position; If your current URL is https://{YOUR_COMPANY}.personio.de/recruiting/positions/12345, then your Job Position ID is `12345`
Recruiting Channel Id	`recruitingChannelId`	`string`	The recruiting channel this application was sourced from. See https://{YOUR_COMPANY}.personio.de/configuration/recruiting/channels.
External Posting Id	`externalPostingId`	`string`	The external id of the job posting (E.g. the external id forwarded by Gohiring).
Message	`message`	`string`	The applicant supplied free-text message.
Application Date	`applicationDate`	`string`	The application date (yyyy-mm-dd). It cannot be a date in the future.
Tags	`tags`	`string[]`	Tags to be associated with this application. Non-existing tags will be created. See https://{YOUR_COMPANY}.personio.de/configuration/recruiting/tags.
Files	`files`	`string[]`	A list of references to previously updated files. These will be attached to the new application. Each file item consists of an uuid, an original_filename and a category. See the documentation.
Attributes	`attributes`	`string[]`	A list of attributes for this applicant. Each attribute item consists of an id and a value. See the documentation.
Phase Type	`phaseType`	`string`	Select a value from the drop down menu:`systemcustom`

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: