Add Contact to Group with SMSTools API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Add Contact to Group action
1. Connect your SMSTools account
2. Configure Phone Number
3. Select a Group ID
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Birthday
7. Optional- Configure Extra 1
8. Optional- Configure Extra 2
9. Optional- Configure Extra 3
10. Optional- Configure Extra 4
11. Optional- Configure Extra 5
12. Optional- Configure Extra 6
13. Optional- Configure Extra 7
14. Optional- Configure Extra 8
15. Optional- Configure Unsubscribed
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#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Add Contact to Group on SMSTools

Description:Adds a new contact to an existing contact list. [See the documentation](https://www.smstools.com/en/sms-gateway-api/add_contact)

Version:0.0.1

Key:smstools-add-contact

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import smstools from "../../smstools.app.mjs";

export default {
  key: "smstools-add-contact",
  name: "Add Contact to Group",
  description: "Adds a new contact to an existing contact list. [See the documentation](https://www.smstools.com/en/sms-gateway-api/add_contact)",
  version: "0.0.1",
  type: "action",
  props: {
    smstools,
    phone: {
      type: "string",
      label: "Phone Number",
      description: "The phone number of the contact.",
    },
    groupid: {
      propDefinition: [
        smstools,
        "groupId",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the contact.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the contact.",
      optional: true,
    },
    birthday: {
      type: "string",
      label: "Birthday",
      description: "Birthday of the contact. **Format: YYYY-MM-DD**.",
      optional: true,
    },
    extra1: {
      type: "string",
      label: "Extra 1",
      description: "Extra field 1 for the contact.",
      optional: true,
    },
    extra2: {
      type: "string",
      label: "Extra 2",
      description: "Extra field 2 for the contact.",
      optional: true,
    },
    extra3: {
      type: "string",
      label: "Extra 3",
      description: "Extra field 3 for the contact.",
      optional: true,
    },
    extra4: {
      type: "string",
      label: "Extra 4",
      description: "Extra field 4 for the contact.",
      optional: true,
    },
    extra5: {
      type: "string",
      label: "Extra 5",
      description: "Extra field 5 for the contact.",
      optional: true,
    },
    extra6: {
      type: "string",
      label: "Extra 6",
      description: "Extra field 6 for the contact.",
      optional: true,
    },
    extra7: {
      type: "string",
      label: "Extra 7",
      description: "Extra field 7 for the contact.",
      optional: true,
    },
    extra8: {
      type: "string",
      label: "Extra 8",
      description: "Extra field 8 for the contact.",
      optional: true,
    },
    unsubscribed: {
      type: "boolean",
      label: "Unsubscribed",
      description: "Indicates if the contact is unsubscribed.",
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const {
        smstools,
        ...data
      } = this;

      const response = await smstools.addContact({
        $,
        data,
      });

      $.export("$summary", `Successfully added contact with ID: ${response.ID}`);
      return response;
    } catch (e) {
      throw new ConfigurationError(e.response.data.errorMsg);
    }
  },
};

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
SMSTools	`smstools`	`app`	This component uses the SMSTools app.
Phone Number	`phone`	`string`	The phone number of the contact.
Group ID	`groupid`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	First name of the contact.
Last Name	`lastName`	`string`	Last name of the contact.
Birthday	`birthday`	`string`	Birthday of the contact. Format: YYYY-MM-DD.
Extra 1	`extra1`	`string`	Extra field 1 for the contact.
Extra 2	`extra2`	`string`	Extra field 2 for the contact.
Extra 3	`extra3`	`string`	Extra field 3 for the contact.
Extra 4	`extra4`	`string`	Extra field 4 for the contact.
Extra 5	`extra5`	`string`	Extra field 5 for the contact.
Extra 6	`extra6`	`string`	Extra field 6 for the contact.
Extra 7	`extra7`	`string`	Extra field 7 for the contact.
Extra 8	`extra8`	`string`	Extra field 8 for the contact.
Unsubscribed	`unsubscribed`	`boolean`	Indicates if the contact is unsubscribed.

Action Authentication#

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

To retrieve your Client ID and Client Secret,