Create Contact with SMSAPI API on New Direct Message (Instant) from Slack API

Pipedream makes it easy to connect APIs for SMSAPI, Slack and 2,200+ other apps remarkably fast.

Trigger workflow on

New Direct Message (Instant) from the Slack API

Next, do this

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

Select this integration
Configure the New Direct Message (Instant) trigger
1. Connect your Slack account
2. Configure slackApphook
3. Optional- Configure Ignore Bots
4. Optional- Configure Ignore Messages from Yourself
Configure the Create Contact action
1. Connect your SMSAPI account
2. Configure First Name
3. Configure Last Name
4. Configure Phone Number
5. Optional- Configure Email
6. Optional- Configure Birthday
7. Optional- Configure City
8. Optional- Configure Description
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 Direct Message (Instant) on Slack

Description:Emit new event when a message was posted in a direct message channel

Version:1.0.19

Key:slack-new-direct-message

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

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

export default {
  ...common,
  key: "slack-new-direct-message",
  name: "New Direct Message (Instant)",
  version: "1.0.19",
  description: "Emit new event when a message was posted in a direct message channel",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return [
          "message.im",
        ];
      },
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreSelf: {
      type: "boolean",
      label: "Ignore Messages from Yourself",
      description: "Ignores messages sent to yourself",
      default: false,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New direct message received";
    },
    processEvent(event) {
      if ((this.ignoreSelf && event.user == this.slack.mySlackId())
        || ((this.ignoreBot) && (event.subtype === "bot_message" || event.bot_id))
        || (event.subtype === "message_changed")) {
        return;
      }
      return event;
    },
  },
  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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`slackApphook`	`$.interface.apphook`
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore Messages from Yourself	`ignoreSelf`	`boolean`	Ignores messages sent to yourself

Trigger Authentication#

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

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

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

Create Contact on SMSAPI

Description:Creates a new contact in SMSAPI. [See the documentation](https://www.smsapi.com/docs/#create-contact)

Version:0.0.1

Key:smsapi-create-contact

View on GitHub

SMSAPI Overview#

The SMSAPI is a tool that lets you send text messages at scale. On Pipedream, you can leverage this API to create workflows that trigger on various events, like incoming emails, form submissions, or scheduled times, and send SMS messages as part of an automated process. This can help with alerts, marketing, or operational communications. Pipedream's capabilities for connecting to various APIs and services enable complex workflows that can be built without managing your own infrastructure.

Action Code#

import smsapi from "../../smsapi.app.mjs";
import queryString from "query-string";

export default {
  key: "smsapi-create-contact",
  name: "Create Contact",
  description: "Creates a new contact in SMSAPI. [See the documentation](https://www.smsapi.com/docs/#create-contact)",
  version: "0.0.1",
  type: "action",
  props: {
    smsapi,
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the contact",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the contact",
    },
    phone: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the contact",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the contact",
      optional: true,
    },
    birthday: {
      type: "string",
      label: "Birthday",
      description: "Birthday of the contact in format `YYYY-MM-DD`",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City of the contact",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the contact",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.smsapi.createContact({
      data: queryString.stringify({
        first_name: this.firstName,
        last_name: this.lastName,
        phone_number: this.phone,
        email: this.email,
        birthday_date: this.birthday,
        city: this.city,
        description: this.description,
      }),
      $,
    });

    if (response?.id) {
      $.export("$summary", `Successfully created contact 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
SMSAPI	`smsapi`	`app`	This component uses the SMSAPI app.
First Name	`firstName`	`string`	First name of the contact
Last Name	`lastName`	`string`	Last name of the contact
Phone Number	`phone`	`string`	Phone number of the contact
Email	`email`	`string`	Email address of the contact
Birthday	`birthday`	`string`	Birthday of the contact in format `YYYY-MM-DD`
City	`city`	`string`	City of the contact
Description	`description`	`string`	Description of the contact

Action Authentication#

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

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

smssms_sendercontactsprofile

Create Contact with SMSAPI API on New Direct Message (Instant) from Slack API

Pipedream makes it easy to connect APIs for SMSAPI, Slack and 2,200+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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