Create Draft with Typefully API on New Incoming SMS (Instant) from ClickSend SMS API

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

Trigger workflow on

New Incoming SMS (Instant) from the ClickSend SMS API

Next, do this

Create Draft with the Typefully 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 Typefully 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 Create Draft action
1. Connect your Typefully account
2. Configure Content
3. Optional- Configure Threadify
4. Optional- Configure Share
5. Optional- Configure Auto Retweet Enabled
6. Optional- Configure Auto Plug Enabled
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#

Create Draft on Typefully

Description:Creates a new draft in Typefully. [See the documentation](https://support.typefully.com/en/articles/8718287-typefully-api#h_df59629cbf)

Version:0.0.1

Key:typefully-create-draft

View on GitHub

Action Code#

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

export default {
  key: "typefully-create-draft",
  name: "Create Draft",
  description: "Creates a new draft in Typefully. [See the documentation](https://support.typefully.com/en/articles/8718287-typefully-api#h_df59629cbf)",
  version: "0.0.1",
  type: "action",
  props: {
    typefully,
    content: {
      propDefinition: [
        typefully,
        "content",
      ],
    },
    threadify: {
      propDefinition: [
        typefully,
        "threadify",
      ],
      optional: true,
    },
    share: {
      propDefinition: [
        typefully,
        "share",
      ],
      optional: true,
    },
    autoRetweetEnabled: {
      propDefinition: [
        typefully,
        "autoRetweetEnabled",
      ],
      optional: true,
    },
    autoPlugEnabled: {
      propDefinition: [
        typefully,
        "autoPlugEnabled",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.typefully.createDraft({
      $,
      data: {
        content: this.content,
        threadify: this.threadify,
        share: this.share,
        auto_retweet_enabled: this.autoRetweetEnabled,
        auto_plug_enabled: this.autoPlugEnabled,
      },
    });

    $.export("$summary", `Created draft with ID: ${response.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
Typefully	`typefully`	`app`	This component uses the Typefully app.
Content	`content`	`string`	You can split into multiple tweets by adding 4 consecutive newlines between tweets in the content
Threadify	`threadify`	`boolean`	Content will be automatically split into multiple tweets
Share	`share`	`boolean`	If true, returned payload will include a share_url
Auto Retweet Enabled	`autoRetweetEnabled`	`boolean`	If true, the post will have an AutoRT enabled, according to the one set on Typefully for the account
Auto Plug Enabled	`autoPlugEnabled`	`boolean`	If true, the post will have an AutoPlug enabled, according to the one set on Typefully for the account