Run Node Code with Node API on Watch Voice Messages (Instant) from ClickSend SMS API

Pipedream makes it easy to connect APIs for Node, ClickSend SMS and 2,400+ other apps remarkably fast.

Trigger workflow on

Watch Voice Messages (Instant) from the ClickSend SMS API

Next, do this

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

Select this integration
Configure the Watch Voice Messages (Instant) trigger
1. Connect your ClickSend SMS account
Configure the Run Node Code action
1. Connect your Node account
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#

Watch Voice Messages (Instant) on ClickSend SMS

Description:Emit new event when a new voice message is received or sent. [See the documentation](https://developers.clicksend.com/docs/rest/v3/#view-voice-receipts)

Version:0.0.1

Key:clicksend-watch-voice-messages-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-watch-voice-messages-instant",
  name: "Watch Voice Messages (Instant)",
  description: "Emit new event when a new voice message is received or sent. [See the documentation](https://developers.clicksend.com/docs/rest/v3/#view-voice-receipts)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const {
        http: { endpoint: actionAddress },
        createVoiceDeliveryReceiptRule,
        setWebhookId,
      } = this;

      const response =
        await createVoiceDeliveryReceiptRule({
          data: {
            rule_name: "PD Voice Receipts",
            match_type: constants.MATCH_TYPE.ALL_REPORTS,
            action: constants.ACTION.URL,
            action_address: actionAddress,
            enabled: constants.ENABLED,
          },
        });

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

      const receiptRuleId = getWebhookId();
      if (receiptRuleId) {
        await deleteVoiceDeliveryReceiptRule({
          receiptRuleId,
        });
      }
    },
  },
  methods: {
    ...common.methods,
    createVoiceDeliveryReceiptRule(args = {}) {
      return this.app.post({
        debug: true,
        path: "/automations/voice/receipts",
        ...args,
      });
    },
    deleteVoiceDeliveryReceiptRule({
      receiptRuleId, ...args
    } = {}) {
      return this.app.delete({
        debug: true,
        path: `/automations/voice/receipts/${receiptRuleId}`,
        ...args,
      });
    },
    generateMeta(resource) {
      return {
        id: resource.message_id,
        summary: `New Voice MSG ${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.

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#

Run Node Code on Node

Description:Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.

Version:0.0.2

Key:node-run-node-code

View on GitHub

Node Overview#

Develop, run and deploy your Node.js code in Pipedream workflows, using it between no-code steps, with connected accounts, or integrate Data Stores and File Stores.

This includes installing NPM packages, within your code without having to manage a package.json file or running npm install.

Below is an example of installing the axios package in a Pipedream Node.js code step. Pipedream imports the axios package, performs the API request, and shares the response with subsequent workflow steps:

Action Code#

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

export default {
  name: "Run Node Code",
  version: "0.0.2",
  key: "node-run-node-code",
  description: "Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.",
  props: {
    node,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Return data to use it in future steps
    return steps.trigger.event;
  },
};