Add New Employee with UpBooks API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Add New Employee action
1. Connect your UpBooks account
2. Configure Name
3. Optional- Configure Employee Number
4. Optional- Select a Type
5. Optional- Configure Email
6. Optional- Configure Phone
7. Optional- Configure DOB
8. Optional- Configure Date Of Joining
9. Optional- Configure Date Of Leaving
10. Configure CTC
11. Select a Salary Component Id
12. Optional- Configure Designation
13. Optional- Select a Role
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#

Weekly schedule on Schedule

Description:Trigger your workflow on one or more days each week at a specific time (with timezone support).

Version:0.0.1

Key:schedule-weekly

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: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 * * 1",
      },
    },
  },
};

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#

Add New Employee on UpBooks

Description:Adds a new employee to Upbooks. [See the documentation](https://www.postman.com/scrrum/workspace/upbooks-io/request/13284127-a51a907a-0648-477d-96f6-f5a9e79262fd)

Version:0.0.1

Key:upbooks-add-employee

View on GitHub

Action Code#

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

export default {
  key: "upbooks-add-employee",
  name: "Add New Employee",
  description: "Adds a new employee to Upbooks. [See the documentation](https://www.postman.com/scrrum/workspace/upbooks-io/request/13284127-a51a907a-0648-477d-96f6-f5a9e79262fd)",
  version: "0.0.1",
  type: "action",
  props: {
    upbooks,
    name: {
      type: "string",
      label: "Name",
      description: "Full name of the employee.",
    },
    employeeNumber: {
      type: "string",
      label: "Employee Number",
      description: "The identification number of the employee.",
      optional: true,
    },
    type: {
      type: "string",
      label: "Type",
      description: "The employee's type.",
      options: [
        "full-time",
        "part-time",
      ],
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The employee's email.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The employee's phone.",
      optional: true,
    },
    dob: {
      type: "string",
      label: "DOB",
      description: "The employee's date of birth. Format: YYYY-MM-DD",
      optional: true,
    },
    dateOfJoining: {
      type: "string",
      label: "Date Of Joining",
      description: "The employee's start date. Format: YYYY-MM-DDTHH:MM:SSZ",
      optional: true,
    },
    dateOfLeaving: {
      type: "string",
      label: "Date Of Leaving",
      description: "The employee's end date. Format: YYYY-MM-DDTHH:MM:SSZ",
      optional: true,
    },
    ctc: {
      type: "integer",
      label: "CTC",
      description: "Cost to company in cents.",
    },
    salaryComponentId: {
      propDefinition: [
        upbooks,
        "salaryComponentId",
      ],
    },
    designation: {
      type: "string",
      label: "Designation",
      description: "In which position the employee will work.",
      optional: true,
    },
    role: {
      type: "string",
      label: "Role",
      description: "The identification of the employee's role.",
      options: [
        "staff",
        "admin",
        "others",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.upbooks.addNewEmployee({
      $,
      data: {
        name: this.name,
        employeeNumber: this.employeeNumber,
        type: this.type,
        email: this.email,
        phone: this.phone,
        dob: this.dob,
        employment: [
          {
            dateOfJoining: this.dateOfJoining,
            dateOfLeaving: this.dateOfLeaving,
            salary: {
              ctc: (this.ctc / 100).toFixed(2),
              componentGroup: {
                id: this.salaryComponentId,
              },
            },
            designation: this.designation,
            role: this.role,
          },
        ],
      },
    });
    $.export("$summary", `Successfully added a new employee with Id: ${response.data._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
UpBooks	`upbooks`	`app`	This component uses the UpBooks app.
Name	`name`	`string`	Full name of the employee.
Employee Number	`employeeNumber`	`string`	The identification number of the employee.
Type	`type`	`string`	Select a value from the drop down menu:`full-timepart-time`
Email	`email`	`string`	The employee's email.
Phone	`phone`	`string`	The employee's phone.
DOB	`dob`	`string`	The employee's date of birth. Format: YYYY-MM-DD
Date Of Joining	`dateOfJoining`	`string`	The employee's start date. Format: YYYY-MM-DDTHH:MM:SSZ
Date Of Leaving	`dateOfLeaving`	`string`	The employee's end date. Format: YYYY-MM-DDTHH:MM:SSZ
CTC	`ctc`	`integer`	Cost to company in cents.
Salary Component Id	`salaryComponentId`	`string`	Select a value from the drop down menu.
Designation	`designation`	`string`	In which position the employee will work.
Role	`role`	`string`	Select a value from the drop down menu:`staffadminothers`

Action Authentication#

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

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