Add Contact with Octopush SMS API on New event when a visitor changes its signed status from Envoy API

Pipedream makes it easy to connect APIs for Octopush SMS, Envoy and 2,500+ other apps remarkably fast.

Trigger workflow on

New event when a visitor changes its signed status from the Envoy API

Next, do this

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

Select this integration
Configure the New event when a visitor changes its signed status trigger
1. Connect your Envoy account
2. Select one or more Signed Status
3. Configure Watching timer
Configure the Add Contact action
1. Connect your Octopush SMS account
2. Configure Phone Number
3. Configure First Name
4. Configure Last Name
5. Optional- Configure List Name
6. Optional- Configure Tag Name
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 event when a visitor changes its signed status on Envoy

Description:Emit new event for each visitor who signed in or out. [See the docs](https://developers.envoy.com/hub/reference/entries-2).

Version:0.0.1

Key:envoy-visitor-signed-status-changed

View on GitHub

Envoy Overview#

The Envoy API empowers users to streamline workplace operations, particularly visitor management, deliveries, and room bookings. Leveraging Pipedream's capabilities, you can automate tasks involving these aspects. For example, you can receive notifications when guests arrive, sync visitor data with other systems, or automate the creation and management of room bookings.

Trigger Code#

import app from "../../envoy.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import { ConfigurationError } from "@pipedream/platform";
import constants from "../common/constants.mjs";

export default {
  key: "envoy-visitor-signed-status-changed",
  name: "New event when a visitor changes its signed status",
  description: "Emit new event for each visitor who signed in or out. [See the docs](https://developers.envoy.com/hub/reference/entries-2).",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    signedStatus: {
      type: "string[]",
      label: "Signed Status",
      description: "Should emit events for which signed status.",
      options: constants.SIGNED_STATUS_OPTS,
    },
    timer: {
      type: "$.interface.timer",
      label: "Watching timer",
      description: "How often to watch the summaries.",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    emit(meta, signedStatus) {
      const ts = Date.parse(meta.createdAt);
      this.$emit(meta, {
        id: `${meta.id}-${meta.signedInAt}-${meta.signedOutAt}`,
        summary: `Visitor ${signedStatus}: ${meta.fullName}`,
        ts,
      });
    },
  },
  async run({ $ }) {
    let today = new Date();
    today.setHours(0, 0, 0, 0);

    if (this.signedStatus.length === 0) {
      throw new ConfigurationError("Signed status is required.");
    }

    const signedInResponse = await this.app.listAllEntriesPages($, {
      signedInAtAfter: today.toISOString(),
      sort: "SIGNED_IN_AT",
      order: "ASC",
    });

    // emitting signed in
    if (this.signedStatus.find((status) => (status === constants.SIGNED_IN))) {
      for (const entry of signedInResponse.filter((entry) => (entry.signedOutAt === null))) {
        this.emit(entry, constants.SIGNED_IN.toLocaleLowerCase());
      }
    }

    // emitting signed out
    if (this.signedStatus.find((status) => (status === constants.SIGNED_OUT))) {
      for (const entry of signedInResponse.filter((entry) => (entry.signedOutAt !== null))) {
        this.emit(entry, constants.SIGNED_OUT.toLocaleLowerCase());
      }
    }
  },
};

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
Envoy	`app`	`app`	This component uses the Envoy app.
Signed Status	`signedStatus`	`string[]`	Select a value from the drop down menu:`Signed inSigned out`
Watching timer	`timer`	`$.interface.timer`	How often to watch the summaries.

Trigger Authentication#

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

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

locations.readcompanies.reademployees.readtoken.refreshinvites.readentries.readinvites.write

About Envoy#

Join thousands of companies that rely on Envoy to efficiently manage hybrid workplaces, so everyone inside can connect, collaborate, and thrive.

Action#

Add Contact on Octopush SMS

Description:Adds a new contact to a list in the Octopush SMS Gateway. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/add-a-contact/)

Version:0.0.1

Key:octopush_sms-add-contact

View on GitHub

Octopush SMS Overview#

The Octopush SMS API lets you programmatically send text messages, providing a powerful way to reach out to customers directly on their phones. With Pipedream, you can create workflows that trigger SMS sending via Octopush based on various events, streamlining communication processes. You could use this API to send alerts, reminders, verification codes, or marketing messages, and integrate with other apps to respond to emails, form submissions, or updates in a CRM.

Action Code#

import octopush from "../../octopush_sms.app.mjs";

export default {
  key: "octopush_sms-add-contact",
  name: "Add Contact",
  description: "Adds a new contact to a list in the Octopush SMS Gateway. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/add-a-contact/)",
  version: "0.0.1",
  type: "action",
  props: {
    octopush,
    phone: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the contact",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the contact",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the contact",
    },
    listName: {
      type: "string",
      label: "List Name",
      description: "  Name of the list to which the contact should be added",
      optional: true,
    },
    tag: {
      type: "string",
      label: "Tag Name",
      description: "Name of the tag that will be attached to the contact",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.octopush.createContact({
      $,
      data: {
        list_name: this.listName,
        contacts: [
          {
            phone_number: this.phone,
            first_name: this.firstName,
            last_name: this.lastName,
          },
        ],
        tag_name: this.tag,
      },
    });
    $.export("$summary", "Successfully created contact.");
    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
Octopush SMS	`octopush`	`app`	This component uses the Octopush SMS app.
Phone Number	`phone`	`string`	Phone number of the contact
First Name	`firstName`	`string`	First name of the contact
Last Name	`lastName`	`string`	Last name of the contact
List Name	`listName`	`string`	Name of the list to which the contact should be added
Tag Name	`tag`	`string`	Name of the tag that will be attached to the contact

Action Authentication#

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

You can get your API Login and Key under API & Integrations > HTTP API Credentials.