Update Employee with HR Cloud API on New Incoming SMS (Instant) from ClickSend SMS API

Pipedream makes it easy to connect APIs for HR Cloud, ClickSend SMS and 2,700+ other apps remarkably fast.

Trigger workflow on

New Incoming SMS (Instant) from the ClickSend SMS API

Next, do this

Update Employee 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 ClickSend SMS 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 Incoming SMS (Instant) trigger
1. Connect your ClickSend SMS account
2. Select a Dedicated Number
3. Configure Message Search Term
Configure the Update Employee action
1. Connect your HR Cloud account
2. Select a Employee
3. Optional- Configure Email
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Street Address
7. Optional- Configure City
8. Optional- Configure State
9. Optional- Configure Zip
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 Incoming SMS (Instant) on ClickSend SMS

Description:Emit new event for each new incoming SMS message received. [See the documentation](https://developers.clicksend.com/docs/rest/v3/#view-inbound-sms)

Version:0.0.1

Key:clicksend-new-incoming-sms-instant

View on GitHub

ClickSend SMS Overview#

The ClickSend SMS API unlocks the potential to integrate robust messaging capabilities into your workflows. With Pipedream, you can not only send SMS messages programmatically but also automate notifications, streamline communication based on events, and much more. Whether you're confirming orders, alerting staff, or engaging with customers, ClickSend and Pipedream make these tasks seamless.

Trigger Code#

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

export default {
  ...common,
  key: "clicksend-new-incoming-sms-instant",
  name: "New Incoming SMS (Instant)",
  description: "Emit new event for each new incoming SMS message received. [See the documentation](https://developers.clicksend.com/docs/rest/v3/#view-inbound-sms)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    dedicatedNumber: {
      propDefinition: [
        common.props.app,
        "dedicatedNumber",
      ],
    },
    messageSearchTerm: {
      type: "string",
      label: "Message Search Term",
      description: "Search for a specific message. Eg `hello world`",
    },
  },
  hooks: {
    async activate() {
      const {
        http: { endpoint: actionAddress },
        dedicatedNumber,
        messageSearchTerm,
        createSMSInboundAutomation,
        setWebhookId,
      } = this;

      const response =
        await createSMSInboundAutomation({
          data: {
            dedicated_number: dedicatedNumber,
            rule_name: "PD Inbound SMS",
            message_search_type: constants.MSG_SEARCH_TYPE.ANY_MSG,
            message_search_term: messageSearchTerm,
            action: constants.ACTION.URL,
            action_address: actionAddress,
            enabled: constants.ENABLED,
            webhook_type: constants.WEBHOOK_TYPE.JSON,
          },
        });

      setWebhookId(response.data.inbound_rule_id);
    },
    async deactivate() {
      const {
        getWebhookId,
        deleteSMSInboundAutomation,
      } = this;

      const inboundRuleId = getWebhookId();
      if (inboundRuleId) {
        await deleteSMSInboundAutomation({
          inboundRuleId,
        });
      }
    },
  },
  methods: {
    ...common.methods,
    createSMSInboundAutomation(args = {}) {
      return this.app.post({
        debug: true,
        path: "/automations/sms/inbound",
        ...args,
      });
    },
    deleteSMSInboundAutomation({
      inboundRuleId, ...args
    } = {}) {
      return this.app.delete({
        debug: true,
        path: `/automations/sms/inbound/${inboundRuleId}`,
        ...args,
      });
    },
    generateMeta(resource) {
      return {
        id: resource.message_id,
        summary: `New SMS: ${resource.message_id}`,
        ts: Date.parse(resource.timestamp),
      };
    },
  },
  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
ClickSend SMS	`app`	`app`	This component uses the ClickSend SMS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Dedicated Number	`dedicatedNumber`	`string`	Select a value from the drop down menu.
Message Search Term	`messageSearchTerm`	`string`	Search for a specific message. Eg `hello world`

Trigger Authentication#

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

Please enter your ClickSend username and API key below.

See the ClickSend docs for more information.

About ClickSend SMS#

Business Communications. Solved.

Action#

Update Employee on HR Cloud

Description:Update an existing employee. [See the documentation](https://help.hrcloud.com/api/#/employee#PUT_employee)

Version:0.0.1

Key:hr_cloud-update-employee

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-update-employee",
  name: "Update Employee",
  description: "Update an existing employee. [See the documentation](https://help.hrcloud.com/api/#/employee#PUT_employee)",
  version: "0.0.1",
  type: "action",
  props: {
    hrCloud,
    employeeId: {
      propDefinition: [
        hrCloud,
        "employeeId",
      ],
    },
    email: {
      propDefinition: [
        hrCloud,
        "email",
      ],
      optional: true,
    },
    firstName: {
      propDefinition: [
        hrCloud,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        hrCloud,
        "lastName",
      ],
      optional: true,
    },
    address: {
      propDefinition: [
        hrCloud,
        "address",
      ],
    },
    city: {
      propDefinition: [
        hrCloud,
        "city",
      ],
    },
    state: {
      propDefinition: [
        hrCloud,
        "state",
      ],
    },
    zip: {
      propDefinition: [
        hrCloud,
        "zip",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.hrCloud.updateEmployee({
      $,
      data: {
        Id: this.employeeId,
        xPersonalEmail: this.email,
        xFirstName: this.firstName,
        xLastName: this.lastName,
        xAddress1: this.address,
        xCity: this.city,
        xState: this.state,
        xZipCode: this.zip,
      },
    });
    $.export("$summary", `Successfully updated employee: ${response[0].xFirstName} ${response[0].xLastName}`);
    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.
Employee	`employeeId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	The employee's email address
First Name	`firstName`	`string`	The employee's first name
Last Name	`lastName`	`string`	The employee's last name
Street Address	`address`	`string`	The street address of the employee
City	`city`	`string`	The city of the employee
State	`state`	`string`	The state of the employee
Zip	`zip`	`integer`	The zip code of the employee

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.

Update Employee with HR Cloud API on New Incoming SMS (Instant) from ClickSend SMS API

Pipedream makes it easy to connect APIs for HR Cloud, ClickSend SMS and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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