Create Newsletter with GetResponse API on New Affiliate Campaign from Relavate API

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

Trigger workflow on

New Affiliate Campaign from the Relavate 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 Relavate 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 New Affiliate Campaign trigger
1. Connect your Relavate account
2. Configure timer
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#

New Affiliate Campaign on Relavate

Description:Emit new event when a new affiliate campaign is created.

Version:0.0.1

Key:relavate-new-affiliate-campaign

View on GitHub

Relavate Overview#

The Relavate API provides tools for managing customer relations and sales efforts, enabling users to automate and optimize their CRM activities. With capabilities for managing contacts, companies, deals, and tasks, the API can serve as a backbone for CRM automation, enhancing customer interaction and business processes efficiency. On Pipedream, you can leverage these functionalities to create advanced workflows, integrate with other apps, and automate tasks based on events from the Relavate system or external triggers.

Trigger Code#

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

export default {
  ...common,
  type: "source",
  key: "relavate-new-affiliate-campaign",
  name: "New Affiliate Campaign",
  description: "Emit new event when a new affiliate campaign is created.",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.relavate.listCampaigns;
    },
    getSummary(campaign) {
      return `New campaign: ${campaign.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
Relavate	`relavate`	`app`	This component uses the Relavate app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your API Key, API Secret, and Partner Type,

Navigate to your Relavate account and sign in
Click the user dropdown on the top right.
Go to “Account” > “Organisation ”> “API”

About Relavate#

Enable, track & reward partners to sell and scale your software.

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.2

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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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 New Affiliate Campaign from Relavate API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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