Update Employee Record with kiwiHR API on New Commit Comment from GitHub API

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

Trigger workflow on

New Commit Comment from the GitHub 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 GitHub 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 New Commit Comment trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
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#

New Commit Comment on GitHub

Description:Emit new event when a commit comment is created

Version:1.0.10

Key:github-new-commit-comment

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-commit-comment",
  name: "New Commit Comment",
  description: "Emit new event when a commit comment is created",
  version: "1.0.10",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** commit comments are not the same as pull request comments. [See the GitHub documentation](https://docs.github.com/en/rest/guides/working-with-comments?apiVersion=2022-11-28) for more information.",
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "commit_comment",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "created";
    },
    getWebhookEventItem(body) {
      return body.comment;
    },
    getSummary(item) {
      return `New comment (${item.id})`;
    },
    getPollingData(args) {
      return this.github.getRepositoryLatestCommitComments(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#commit_comment";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/comments?apiVersion=2022-11-28#list-commit-comments-for-a-repository";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

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

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

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

Update Employee Record with kiwiHR API on New Commit Comment from GitHub API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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