Create Email List with SurveyMethods API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Email List action
1. Connect your SurveyMethods account
2. Configure Name
3. Select a Email List Type
4. Optional- Configure Custom Fields Labels
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#

Weekly schedule on Schedule

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

Version:0.0.1

Key:schedule-weekly

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: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week 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#

Create Email List on SurveyMethods

Description:Creates a email list. [See docs here in 8.2](https://app.surveymethods.com/t-help/api/surveymethodsapidocumentv1.pdf)

Version:0.0.1

Key:surveymethods-create-email-list

View on GitHub

SurveyMethods Overview#

The SurveyMethods API allows users to automate the management and analysis of surveys and the corresponding data. With the Pipedream integration, you can trigger workflows based on survey events, sync survey results with other databases or apps, and manage survey distribution programmatically. This serves to streamline the survey process from distribution to data actioning, all in real-time and without the need for manual intervention.

Action Code#

import surveymethods from "../../surveymethods.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "Create Email List",
  version: "0.0.1",
  key: "surveymethods-create-email-list",
  description: "Creates a email list. [See docs here in 8.2](https://app.surveymethods.com/t-help/api/surveymethodsapidocumentv1.pdf)",
  type: "action",
  props: {
    surveymethods,
    name: {
      label: "Name",
      description: "The email list name",
      type: "string",
    },
    emailListType: {
      label: "Email List Type",
      description: "The email list type",
      type: "string",
      options: constants.EMAIL_LIST_TYPES,
    },
    customFieldsLabels: {
      label: "Custom Fields Labels",
      description: "The email list custom fields labels. E.g. `FirstName,LastName,Company,Location,Representative ID`",
      type: "string",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.surveymethods.createEmailList({
      $,
      data: {
        email_list_type: "Advanced",
        email_list_name: this.name,
        custom_field_labels: this.customFieldsLabels ?? "",
      },
    });

    if (response) {
      $.export("$summary", `Successfully created email list with id ${response.email_list.code}`);
    }

    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
SurveyMethods	`surveymethods`	`app`	This component uses the SurveyMethods app.
Name	`name`	`string`	The email list name
Email List Type	`emailListType`	`string`	Select a value from the drop down menu:`AdvancedBasic`
Custom Fields Labels	`customFieldsLabels`	`string`	The email list custom fields labels. E.g. `FirstName,LastName,Company,Location,Representative ID`

Action Authentication#

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

Use your account email address as your Login ID.
To get your API Key, follow the below steps:

Log in to your SurveyMethods account using your login id and password. The email
address that you provide during the registration will be your login id.
Go to the My Account Section.
Click on the API tab.