Create Task with HR Cloud API on New Current Message from Vestaboard API

Pipedream makes it easy to connect APIs for HR Cloud, Vestaboard and 2,900+ other apps remarkably fast.

Trigger workflow on

New Current Message from the Vestaboard API

Next, do this

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

Select this integration
Configure the New Current Message trigger
1. Connect your Vestaboard account
2. Configure timer
Configure the Create Task action
1. Connect your HR Cloud account
2. Select a Application Code
3. Configure Title
4. Select one or more Employee IDs
5. Select a Assignee Type
6. Optional- Select a Assignee Employee ID
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 Current Message on Vestaboard

Description:Emit new event when a new message is displayed on a board. [See the docs](https://docs.vestaboard.com/read-write)

Version:0.0.1

Key:vestaboard-new-current-message

View on GitHub

Vestaboard Overview#

The Vestaboard API allows you to control a networked, mechanical split-flap display, enabling you to automate the content it shows. By integrating with Pipedream, you can develop serverless workflows that respond to various triggers (like incoming webhooks, emails, or scheduled timers) and push updates to your Vestaboard. You can dynamically display information such as meeting reminders, real-time performance metrics, or custom messages based on events from other apps and services.

Trigger Code#

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

export default {
  key: "vestaboard-new-current-message",
  name: "New Current Message",
  description: "Emit new event when a new message is displayed on a board. [See the docs](https://docs.vestaboard.com/read-write)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    vestaboard,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      const { currentMessage } = await this.vestaboard.getCurrentMessage();
      if (!currentMessage) {
        return;
      }
      this.emitEvent(currentMessage);
      this._setPreviousId(currentMessage.id);
    },
  },
  methods: {
    _getPreviousId() {
      return this.db.get("previousId");
    },
    _setPreviousId(previousId) {
      this.db.set("previousId", previousId);
    },
    generateMeta({ id }) {
      const ts = Date.now();
      return {
        id: `${id}${ts}`,
        summary: `New Message with ID ${id}`,
        ts,
      };
    },
    emitEvent(message) {
      const meta = this.generateMeta(message);
      this.$emit(message, meta);
    },
  },
  async run() {
    const previousId = this._getPreviousId();
    const { currentMessage } = await this.vestaboard.getCurrentMessage();
    if (!currentMessage || currentMessage.id === previousId) {
      return;
    }
    this.emitEvent(currentMessage);
    this._setPreviousId(currentMessage.id);
  },
};

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
Vestaboard	`vestaboard`	`app`	This component uses the Vestaboard app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your API keys,

Navigate to your Vestaboard account and sign in
Go to “API” > “Installables”
On one of your Installables, click on “DETAILS”
Go to “API Credentials”
Navigate to "API" > "Read/Write API"
Click "Enabled" and copy your Read/Write API Key.

About Vestaboard#

Vestaboard is smart messaging display you control with your phone or PC.

Action#

Create Task on HR Cloud

Description:Creates a new task. [See the documentation](https://help.hrcloud.com/api/#/task#POST_tasks)

Version:0.0.2

Key:hr_cloud-create-task

View on GitHub

HR Cloud Overview#

HR Cloud is a human resources management system (HRMS) that helps businesses manage their employee data, payroll, benefits, time tracking, and more. This integration enables you to automate your HR workflows by connecting HR Cloud with thousands of other apps on Pipedream.

Action Code#

import hrCloud from "../../hr_cloud.app.mjs";

export default {
  key: "hr_cloud-create-task",
  name: "Create Task",
  description: "Creates a new task. [See the documentation](https://help.hrcloud.com/api/#/task#POST_tasks)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    hrCloud,
    applicationCode: {
      propDefinition: [
        hrCloud,
        "applicationCode",
      ],
      reloadProps: true,
    },
    title: {
      propDefinition: [
        hrCloud,
        "title",
      ],
    },
    employeeIds: {
      propDefinition: [
        hrCloud,
        "employeeId",
      ],
      type: "string[]",
      label: "Employee IDs",
      description: "Array of related employee IDs",
    },
    assigneeType: {
      propDefinition: [
        hrCloud,
        "assigneeType",
      ],
      reloadProps: true,
    },
    assignedEmployeeId: {
      propDefinition: [
        hrCloud,
        "employeeId",
      ],
      label: "Assignee Employee ID",
      description: "ID of assigned employee",
      hidden: true,
      optional: true,
    },
  },
  additionalProps(existingProps) {
    const props = {};

    if (this.assigneeType === "SpecificEmployee") {
      existingProps.assignedEmployeeId.hidden = false;
      existingProps.assignedEmployeeId.optional = false;
    }

    if (this.assigneeType === "Hierarchy") {
      props.hierarchyLevel = {
        type: "integer",
        label: "Hierarchy Level",
        description: "Level of upper hierarchy level. From 1 to 9",
        max: 9,
      };
    }

    if (this.applicationCode === "coreHr" || this.applicationCode === "benefits") {
      props.fixedDueDate = {
        type: "string",
        label: "Fixed Due Date",
        description: "Fixed DueDate to complete task (YYYY-MM-DD)",
      };
    }

    if (this.applicationCode === "onboard" || this.applicationCode === "offboard") {
      props.relativeDueDate = {
        type: "string",
        label: "Relative Due Date",
        description: "Relative DueDate for StartDate or SeparationDate to complete task. Example: `{\"timeUnit\": \"Day\", \"direction\": \"After\", \"offset\": 10}`",
      };
    }

    return props;
  },
  async run({ $ }) {
    const response = await this.hrCloud.createTask({
      $,
      data: {
        taskType: "task",
        applicationCode: this.applicationCode,
        title: this.title,
        relatedToEmployeeIds: this.employeeIds,
        assigneeType: this.assigneeType,
        assignedEmployeeId: this.assignedEmployeeId,
        hierarchyLevel: this.hierarchyLevel,
        fixedDueDate: this.fixedDueDate,
        relativeDueDate: typeof this.relativeDueDate === "string"
          ? JSON.parse(this.relativeDueDate)
          : this.relativeDueDate,
      },
    });

    $.export("$summary", `Successfully created task \`${this.title}\``);
    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
HR Cloud	`hrCloud`	`app`	This component uses the HR Cloud app.
Application Code	`applicationCode`	`string`	Select a value from the drop down menu:`coreHronboardbenefitsoffboard`
Title	`title`	`string`	The title of a task
Employee IDs	`employeeIds`	`string[]`	Select a value from the drop down menu.
Assignee Type	`assigneeType`	`string`	Select a value from the drop down menu:`EmployeeManagerManagersManagerHrAdminHrUserHrOperationItUserItOperationSpecificEmployeeHierarchy`

Action Authentication#

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

To retrieve your Consumer Key and Consumer Secret,

Navigate to your HR Cloud account and sign in
Go to “Settings” > “Service Accounts”
Copy your Consumer Key and Consumer Secret from the Service Account list
Note: Make sure your Service Account status is set to active.