Add Contact with Octopush SMS API on New Deal Created from CompanyHub API

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

Trigger workflow on

New Deal Created from the CompanyHub 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 CompanyHub 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 Deal Created trigger
1. Connect your CompanyHub account
2. Configure 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 Deal Created on CompanyHub

Description:Emit new event when a new deal is created. [See the documentation](https://companyhub.com/docs/api-documentation)

Version:0.0.1

Key:companyhub-new-deal-created

View on GitHub

CompanyHub Overview#

The CompanyHub API offers a platform for seamless CRM automation, enabling you to streamline sales processes, manage customer interactions, and analyze data efficiently. With it, you can automate tasks like data entry, lead tracking, and follow-ups, saving time and eliminating manual errors. Pipedream's integration capabilities allow you to connect CompanyHub with other apps to create custom, automated workflows that trigger actions based on events, sync data across platforms, or generate real-time notifications.

Trigger Code#

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

export default {
  ...common,
  key: "companyhub-new-deal-created",
  name: "New Deal Created",
  description: "Emit new event when a new deal is created. [See the documentation](https://companyhub.com/docs/api-documentation)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.companyhub.listDeals;
    },
    getSummary(item) {
      return `New Deal: ${item.Name}`;
    },
  },
  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
CompanyHub	`companyhub`	`app`	This component uses the CompanyHub app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To access your API Key and Subdomain, sign into your CompanyHub account, then navigate to Settings > Integrations.

About CompanyHub#

CompanyHub is a sales automation CRM for sales teams that can be completely tailored for your industry.

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