Create a Subscription with Pipedream API on New Message Received from Salesmsg API

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

Trigger workflow on

New Message Received from the Salesmsg API

Next, do this

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

Select this integration
Configure the New Message Received trigger
1. Connect your Salesmsg account
2. Configure Polling interval
3. Select a Contact Id
Configure the Create a Subscription action
1. Connect your Pipedream account
2. Select a Subscription category
3. Select a Subscription source
4. Optional- Select a Event name
5. Configure Listener 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 Message Received on Salesmsg

Description:Emit new event when a new message is received.

Version:0.0.1

Key:salesmsg-message-received

View on GitHub

Salesmsg Overview#

The Salesmsg API facilitates two-way SMS and MMS communications, allowing users to send, receive, and manage messages programmatically. It provides a suite of tools to integrate texting capabilities into various workflows and systems. On Pipedream, you can harness this API to automate conversations, sync with customer databases, trigger notifications, and much more, utilizing Pipedream's serverless platform to connect Salesmsg with a plethora of other apps and services.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import salesmsg from "../../salesmsg.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "salesmsg-message-received",
  name: "New Message Received",
  version: "0.0.1",
  description: "Emit new event when a new message is received.",
  type: "source",
  dedupe: "unique",
  props: {
    salesmsg,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Salesmsg API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    contactId: {
      propDefinition: [
        salesmsg,
        "contactId",
      ],
    },
  },
  methods: {
    _getLastId() {
      return this.db.get("lastId") || 0;
    },
    _setLastId(lastId) {
      this.db.set("lastId", lastId);
    },
    async startEvent(maxResults = 0) {

      const lastId = this._getLastId();
      const items = this.salesmsg.paginateMessages({
        maxResults,
        params: {
          contacts: [
            this.contactId,
          ],
        },
      });

      let responseArray = [];

      for await (const item of items) {
        if (item.id <= lastId) break;
        responseArray.push(item);

        if (responseArray.length) this._setLastId(responseArray[0].id);

        for (const item of responseArray.reverse()) {
          this.$emit(
            item,
            {
              id: item.id,
              summary: `A new message with id: "${item.id}" was received!`,
              ts: item.created_at,
            },
          );
        }
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  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
Salesmsg	`salesmsg`	`app`	This component uses the Salesmsg app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Salesmsg API on this schedule
Contact Id	`contactId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Salesmsg uses OAuth authentication. When you connect your Salesmsg account, Pipedream will open a popup window where you can sign into Salesmsg and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Salesmsg API.

Pipedream requests the following authorization scopes when you connect your account:

public-api

About Salesmsg#

One SMS app for your entire company. 2-way texting, SMS marketing, calling, & more.

Action#

Create a Subscription on Pipedream

Description:Create a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#subscriptions)

Version:0.1.0

Key:pipedream-create-subscription

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Action Code#

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

export default {
  key: "pipedream-create-subscription",
  name: "Create a Subscription",
  description: "Create a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#subscriptions)",
  version: "0.1.0",
  type: "action",
  props: {
    pipedream,
    subscriptionCategory: {
      propDefinition: [
        pipedream,
        "subscriptionCategory",
      ],
    },
    subscriptionSource: {
      propDefinition: [
        pipedream,
        "subscriptionSource",
        (c) => ({
          subscriptionCategory: c.subscriptionCategory,
        }),
      ],
    },
    eventName: {
      propDefinition: [
        pipedream,
        "eventName",
      ],
    },
    listenerId: {
      propDefinition: [
        pipedream,
        "listenerId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.pipedream
      .subscribe(this.subscriptionSource, this.listenerId, this.eventName);
    response?.data?.length > 0 && $.export("$summary", "Successfully created Subscription");
    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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Subscription category	`subscriptionCategory`	`string`	Select a value from the drop down menu:`OrganisationUserGlob patterns`
Subscription source	`subscriptionSource`	`string`	Select a value from the drop down menu.
Event name	`eventName`	`string`	Select a value from the drop down menu:`$errors$logs`
Listener ID	`listenerId`	`string`	The ID of the component or workflow you'd like to receive events

Action Authentication#

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

About Pipedream#

Integration platform for developers

More Ways to Connect Pipedream + Salesmsg#

Other Popular Integrations#

Search Conversations with Salesmsg API on New Scheduled Tasks from Pipedream API

Pipedream + Salesmsg

Create a Subscription with Pipedream API on New Message Received from Salesmsg API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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