Create Newsletter with GetResponse API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

Create Newsletter with the GetResponse 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 GetResponse 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 Newsletter action
1. Connect your GetResponse account
2. Optional- Configure Name
3. Optional- Select a Type
4. Select a Campaign ID
5. Configure Subject
6. Select a From Field ID
7. Select one or more Selected Campaigns
8. Optional- Select one or more Selected Contacts
9. Optional- Select one or more Selected Segments
10. Select a Content Type
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 Newsletter on GetResponse

Description:Creates a new newsletter and puts it in a queue to send. [See the docs here](https://apireference.getresponse.com/?_ga=2.47520738.499257728.1666974700-2116668472.1666974700&_gl=1*1f3h009*_ga*MjExNjY2ODQ3Mi4xNjY2OTc0NzAw*_ga_EQ6LD9QEJB*MTY2Njk3NzM0Ny4yLjEuMTY2Njk3ODQ3OS4zNi4wLjA.#operation/createNewsletter)

Version:0.0.1

Key:getresponse-create-newsletter

View on GitHub

GetResponse Overview#

GetResponse API integrates email marketing and online campaign management tools into your applications for creating and managing mailing lists, newsletters, automated campaigns, and more. With Pipedream, this functionality expands, allowing you to automate workflows between GetResponse and various apps. Integration can trigger actions like updating contacts, processing event-driven emails, or syncing subscriber lists across platforms.

Action Code#

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

export default {
  key: "getresponse-create-newsletter",
  name: "Create Newsletter",
  description: "Creates a new newsletter and puts it in a queue to send. [See the docs here](https://apireference.getresponse.com/?_ga=2.47520738.499257728.1666974700-2116668472.1666974700&amp;_gl=1*1f3h009*_ga*MjExNjY2ODQ3Mi4xNjY2OTc0NzAw*_ga_EQ6LD9QEJB*MTY2Njk3NzM0Ny4yLjEuMTY2Njk3ODQ3OS4zNi4wLjA.#operation/createNewsletter)",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "The newsletter name",
      optional: true,
    },
    type: {
      type: "string",
      label: "Type",
      description: "The newsletter type",
      optional: true,
      options: [
        "broadcast",
        "draft",
      ],
    },
    campaignId: {
      propDefinition: [
        app,
        "campaignId",
      ],
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The newsletter name",
    },
    fromFieldId: {
      propDefinition: [
        app,
        "fromFieldId",
      ],
    },
    selectedCampaigns: {
      type: "string[]",
      label: "Selected Campaigns",
      description: "Specify which campaigns you will want the message be deliver to.",
      propDefinition: [
        app,
        "campaignId",
      ],
    },
    selectedContacts: {
      type: "string[]",
      label: "Selected Contacts",
      description: "Specify which contacts you will want the message be deliver to.",
      propDefinition: [
        app,
        "contactId",
      ],
      optional: true,
    },
    selectedSegments: {
      type: "string[]",
      label: "Selected Segments",
      description: "Specify which segments you will want the message be deliver to.",
      propDefinition: [
        app,
        "searchContactId",
      ],
      optional: true,
    },
    contentType: {
      type: "string",
      label: "Content Type",
      description: "Flag to show either **Text Content** or **HTML Content** property",
      options: constants.CONTENT_TYPE_OPTIONS,
      default: "plain",
      reloadProps: true,
    },
  },
  async additionalProps() {
    if (this.contentType === constants.CONTENT_TYPE_OPTIONS[1]) {
      return {
        html: {
          type: "string",
          label: "HTML Content",
          description: "The message content in HTML",
        },
      };
    }

    return {
      plain: {
        type: "string",
        label: "Text Content",
        description: "The plain text equivalent of the message content",
      },
    };
  },
  async run({ $: step }) {
    const {
      campaignId,
      subject,
      fromFieldId,
      selectedCampaigns,
      selectedContacts,
      selectedSegments,
      name,
      type,
    } = this;

    const contentType =
      constants.CONTENT_TYPE_OPTIONS.includes(this.contentType)
      && this.contentType
      || constants.CONTENT_TYPE_OPTIONS[0];

    const content = this[contentType];

    const response = await this.app.createNewsletter({
      step,
      data: {
        name,
        type,
        subject,
        campaign: {
          campaignId,
        },
        content: {
          [contentType]: content,
        },
        fromField: {
          fromFieldId,
        },
        sendSettings: {
          selectedCampaigns,
          selectedSegments,
          selectedContacts,
        },
      },
    });

    step.export("$summary", "The newsletter has been put in a queue to send.");

    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
GetResponse	`app`	`app`	This component uses the GetResponse app.
Name	`name`	`string`	The newsletter name
Type	`type`	`string`	Select a value from the drop down menu:`broadcastdraft`
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Subject	`subject`	`string`	The newsletter name
From Field ID	`fromFieldId`	`string`	Select a value from the drop down menu.
Selected Campaigns	`selectedCampaigns`	`string[]`	Select a value from the drop down menu.
Selected Contacts	`selectedContacts`	`string[]`	Select a value from the drop down menu.
Selected Segments	`selectedSegments`	`string[]`	Select a value from the drop down menu.
Content Type	`contentType`	`string`	Select a value from the drop down menu:`plainhtml`

Action Authentication#

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

To connect GetResponse to Pipedream,

Find your unique and secret API key in the panel: https://app.getresponse.com/api
Paste that key below

Create Newsletter with GetResponse API on Weekly schedule from Schedule API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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