Create Employee with Breathe API on New Record from Knack API

Pipedream makes it easy to connect APIs for Breathe, Knack and 2,800+ other apps remarkably fast.

Trigger workflow on

New Record from the Knack API

Next, do this

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

Select this integration
Configure the New Record trigger
1. Connect your Knack account
2. Configure Object Key
3. Configure timer
Configure the Create Employee action
1. Connect your Breathe account
2. Configure First Name
3. Configure Last Name
4. Configure Email
5. Configure Company Join Date
6. Optional- Configure Date of Birth
7. Optional- Configure Job Title
8. Optional- Select a Department ID
9. Optional- Select a Division ID
10. Optional- Select a Location ID
11. Optional- Select a Working Pattern ID
12. Optional- Select a Holiday Allowance ID
13. Optional- Configure Work Mobile
14. Optional- Configure Personal Mobile
15. Optional- Configure Home Telephone
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 Record on Knack

Description:Emit new event for each record created

Version:0.0.2

Key:knack-new-record

View on GitHub

Knack Overview#

The Knack API allows for robust interactions with your Knack database, enabling automation of data entry, retrieval, updates, and deletion. With Pipedream, you can leverage these capabilities to create seamless workflows that react to events in real-time, sync data across platforms, and enhance your database management without manual intervention. Think less about CRUD operations and more about the magic of connecting your Knack data to the digital tools ecosystem.

Trigger Code#

import knack from "../../knack.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "knack-new-record",
  name: "New Record",
  description: "Emit new event for each record created",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    knack,
    objectKey: {
      type: "string",
      label: "Object Key",
      description: "The key of the object which this record belongs to. See [the Knack API docs](https://docs.knack.com/docs/object-based-requests) for more information.",
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run({ $ }) {
    const records = await this.knack.getAllRecords($, {
      objectKey: this.objectKey,
    }, {
      rows_per_page: 100,
    }, true);

    for (const record of records) {
      this.$emit(record, {
        id: record.id,
        summary: `New record ${record.id}`,
        ts: new Date(),
      });
    }
  },
};

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
Knack	`knack`	`app`	This component uses the Knack app.
Object Key	`objectKey`	`string`	The key of the object which this record belongs to. See the Knack API docs for more information.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Object-based requests require at least two headers: an application ID - to identify to our servers the app whose records you are requesting - and an API key (which is specific to each app) to authenticate the request. See docs

About Knack#

Business app platform

Action#

Create Employee on Breathe

Description:Creates a new employee in Breathe. [See the documentation](https://developer.breathehr.com/examples#!/employees/POST_version_employees_json)

Version:0.0.1

Key:breathe-create-employee

View on GitHub

Action Code#

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

export default {
  key: "breathe-create-employee",
  name: "Create Employee",
  description: "Creates a new employee in Breathe. [See the documentation](https://developer.breathehr.com/examples#!/employees/POST_version_employees_json)",
  version: "0.0.1",
  type: "action",
  props: {
    breathe,
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the employee",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the employee",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the employee",
    },
    companyJoinDate: {
      type: "string",
      label: "Company Join Date",
      description: "The date that the employee joined the company. Example: `2023-12-25`",
    },
    dob: {
      type: "string",
      label: "Date of Birth",
      description: "The date of birth of the employee",
      optional: true,
    },
    jobTitle: {
      type: "string",
      label: "Job Title",
      description: "The job title of the employee",
      optional: true,
    },
    departmentId: {
      propDefinition: [
        breathe,
        "departmentId",
      ],
    },
    divisionId: {
      propDefinition: [
        breathe,
        "divisionId",
      ],
    },
    locationId: {
      propDefinition: [
        breathe,
        "locationId",
      ],
    },
    workingPatternId: {
      propDefinition: [
        breathe,
        "workingPatternId",
      ],
    },
    holidayAllowanceId: {
      propDefinition: [
        breathe,
        "holidayAllowanceId",
      ],
    },
    workMobile: {
      type: "string",
      label: "Work Mobile",
      description: "The work moblie phone number of the employee",
      optional: true,
    },
    personalMobile: {
      type: "string",
      label: "Personal Mobile",
      description: "The personal mobile phone number of the employee",
      optional: true,
    },
    homeTelephone: {
      type: "string",
      label: "Home Telephone",
      description: "The home telephone number of the employee",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.breathe.createEmployee({
      $,
      data: {
        employee: {
          person_type: "Employee",
          first_name: this.firstName,
          last_name: this.lastName,
          email: this.email,
          company_join_date: this.companyJoinDate,
          dob: this.dob,
          job_title: this.jobTitle,
          work_mobile: this.workMobile,
          personal_mobile: this.personalMobile,
          home_telephone: this.homeTelephone,
          department: this.departmentId,
          division: this.divisionId,
          location: this.locationId,
          working_pattern: this.workingPatternId,
          holiday_allowance: this.holidayAllowanceId,
        },
      },
    });
    $.export("$summary", `Successfully created employee with ID: ${response.employees[0].id}`);
    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
Breathe	`breathe`	`app`	This component uses the Breathe app.
First Name	`firstName`	`string`	First name of the employee
Last Name	`lastName`	`string`	Last name of the employee
Email	`email`	`string`	Email address of the employee
Company Join Date	`companyJoinDate`	`string`	The date that the employee joined the company. Example: `2023-12-25`
Date of Birth	`dob`	`string`	The date of birth of the employee
Job Title	`jobTitle`	`string`	The job title of the employee
Department ID	`departmentId`	`string`	Select a value from the drop down menu.
Division ID	`divisionId`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.
Working Pattern ID	`workingPatternId`	`string`	Select a value from the drop down menu.
Holiday Allowance ID	`holidayAllowanceId`	`string`	Select a value from the drop down menu.
Work Mobile	`workMobile`	`string`	The work moblie phone number of the employee
Personal Mobile	`personalMobile`	`string`	The personal mobile phone number of the employee
Home Telephone	`homeTelephone`	`string`	The home telephone number of the employee