New Incoming SMS (Instant) from ClickSend SMS API

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

Trigger workflow on

New Incoming SMS (Instant) from the ClickSend SMS API

Next, do this

Connect to 2,400+ APIs using code and no-code building blocks

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#

Trigger a workflow on New Incoming SMS (Instant) with ClickSend SMS API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Incoming SMS (Instant) trigger
1. Connect your ClickSend SMS account
2. Select a Dedicated Number
3. Configure Message Search Term
Add steps to connect to 2,400+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Film with SWAPI - Star Wars API on New Incoming SMS (Instant) from ClickSend SMS API

ClickSend SMS + SWAPI - Star Wars

Try it

Send any HTTP Request with HTTP / Webhook API on New Incoming SMS (Instant) from ClickSend SMS API

ClickSend SMS + HTTP / Webhook

Try it

Get Backlinks with Ahrefs API on New Incoming SMS (Instant) from ClickSend SMS API

ClickSend SMS + Ahrefs

Try it

Execute Query with Snowflake API on New Incoming SMS (Instant) from ClickSend SMS API

ClickSend SMS + Snowflake

Try it

[Date/Time] Add/Subtract Time with Formatting API on New Incoming SMS (Instant) from ClickSend SMS API

ClickSend SMS + Formatting

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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,
};

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`

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.