Create Broadcast with AWeber API on New Contact Created from SuperPhone API

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

Trigger workflow on

New Contact Created from the SuperPhone API

Next, do this

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

Select this integration
Configure the New Contact Created trigger
1. Connect your SuperPhone account
Configure the Create Broadcast action
1. Connect your AWeber account
2. Select a Account ID
3. Select a List ID
4. Optional- Configure Body HTML
5. Optional- Configure Body Text
6. Optional- Configure Body AMP
7. Optional- Configure Click Tracking Enabled
8. Optional- Select one or more Exclude Lists
9. Optional- Select one or more Include Lists
10. Optional- Select a Facebook Integration
11. Optional- Configure Is Archived
12. Optional- Configure Notify on Send
13. Optional- Select a Segment Link
14. Configure Subject
15. Optional- Select a Twitter Integration
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 Contact Created on SuperPhone

Description:Triggered when a new contact is created. [See the documentation](https://api.superphone.io/docs/webhooksubscription.doc.html)

Version:0.0.1

Key:superphone-new-contact-created

View on GitHub

SuperPhone Overview#

SuperPhone is a communication platform that allows users to manage text and call campaigns through a personal phone number. Leveraging the SuperPhone API on Pipedream, you can automate interactions with contacts, send personalized messages, and get analytics on message deliverability and engagement. With Pipedream's serverless platform, you can trigger workflows on various events, like receiving a new message or a specific keyword, and connect to countless other apps to extend functionality.

Trigger Code#

import common from "../common/webhook.mjs";
import subscriptions from "../common/subscriptions.mjs";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  key: "superphone-new-contact-created",
  name: "New Contact Created",
  description: "Triggered when a new contact is created. [See the documentation](https://api.superphone.io/docs/webhooksubscription.doc.html)",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourcesFn() {
      return this.app.listContacts;
    },
    getResourcesFnArgs() {
      return {
        first: constants.DEFAULT_LIMIT,
      };
    },
    getResourcesName() {
      return "contacts";
    },
    getSubscriptions() {
      return [
        subscriptions.CONTACT_ADDED,
      ];
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Contact: ${resource.id}`,
        ts: Date.parse(resource.createdAt),
      };
    },
  },
};

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
SuperPhone	`app`	`app`	This component uses the SuperPhone app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

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

About SuperPhone#

SuperPhone® for Coaches & Creators

Action#

Create Broadcast on AWeber

Description:Create a broadcast under the specified account and list. [See the documentation](https://api.aweber.com/#tag/Broadcasts/paths/~1accounts~1%7BaccountId%7D~1lists~1%7BlistId%7D~1broadcasts/post).

Version:0.0.1

Key:aweber-create-broadcast

View on GitHub

AWeber Overview#

AWeber's API provides a suite of tools to automate email marketing efforts, enabling developers to manage subscribers, send emails, and track results programmatically. With the AWeber API on Pipedream, you can create custom workflows that react to various triggers and connect with other services to streamline your email campaigns, analyze performance, and enhance subscriber engagement.

Action Code#

import aweberApp from "../../aweber.app.mjs";

export default {
  key: "aweber-create-broadcast",
  name: "Create Broadcast",
  description: "Create a broadcast under the specified account and list. [See the documentation](https://api.aweber.com/#tag/Broadcasts/paths/~1accounts~1%7BaccountId%7D~1lists~1%7BlistId%7D~1broadcasts/post).",
  type: "action",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    aweberApp,
    accountId: {
      propDefinition: [
        aweberApp,
        "accountId",
      ],
    },
    listId: {
      propDefinition: [
        aweberApp,
        "listId",
        ({ accountId }) => ({
          accountId,
        }),
      ],
    },
    bodyHTML: {
      type: "string",
      label: "Body HTML",
      description: "The content of the message in HTML format. If `Body Text` is not provided, it will be auto-generated. If `Body Text` is not provided, `Body HTML` must be provided.",
      optional: true,
    },
    bodyText: {
      type: "string",
      label: "Body Text",
      description: "The content of the message in plain text, used when HTML is not supported. If `Body HTML` is not provided, the broadcast will be sent using only the `Body Text`. If `Body Text` is not provided, `Body HTML` must be provided.",
      optional: true,
    },
    bodyAmp: {
      type: "string",
      label: "Body AMP",
      description: "The content of the message in AMP format. [Read Aweber KB article before using this field](https://help.aweber.com/hc/en-us/articles/360025741194)",
      optional: true,
    },
    clickTrackingEnabled: {
      type: "boolean",
      label: "Click Tracking Enabled",
      description: "Enables links in the email message to be tracked.",
      optional: true,
    },
    excludeLists: {
      propDefinition: [
        aweberApp,
        "listSelfLink",
        ({ accountId }) => ({
          accountId,
        }),
      ],
      type: "string[]",
      label: "Exclude Lists",
      description: "List of [Lists](https://api.aweber.com/#tag/Lists) URLs to exclude in the delivery of this broadcast. **e.g. `https://api.aweber.com/1.0/accounts/<account_id>/lists/<list_id>`**",
      optional: true,
    },
    includeLists: {
      propDefinition: [
        aweberApp,
        "listSelfLink",
        ({ accountId }) => ({
          accountId,
        }),
      ],
      type: "string[]",
      label: "Include Lists",
      description: "List of [Lists](https://api.aweber.com/#tag/Lists) URLs to include in the delivery of this broadcast. **e.g. `https://api.aweber.com/1.0/accounts/<account_id>/lists/<list_id>`**",
      optional: true,
    },
    facebookIntegration: {
      propDefinition: [
        aweberApp,
        "integrations",
        ({ accountId }) => ({
          accountId,
          serviceName: "facebook",
        }),
      ],
      label: "Facebook Integration",
      description: "URL to the [Facebook broadcast integration](https://api.aweber.com/#tag/Integrations) to use for this broadcast. When the broadcast is sent, the subject of the broadcast will be posted to this Facebook integration - **e.g. `https://api.aweber.com/1.0/accounts/<account_id>/integrations/<integration_id>`**.",
      optional: true,
    },
    isArchived: {
      type: "boolean",
      label: "Is Archived",
      description: "Whether the broadcast enabled sharing via an archive URL.",
      optional: true,
    },
    notifyOnSend: {
      type: "boolean",
      label: "Notify on Send",
      description: "If true, notify when stats are available on a sent broadcast message.",
      optional: true,
    },
    segmentLink: {
      propDefinition: [
        aweberApp,
        "segmentSelfLink",
        ({
          accountId, listId,
        }) => ({
          accountId,
          listId,
        }),
      ],
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The broadcast subject line. Subject must not be empty nor contain only whitespace.",
    },
    twitterIntegration: {
      propDefinition: [
        aweberApp,
        "integrations",
        ({ accountId }) => ({
          accountId,
          serviceName: "twitter",
        }),
      ],
      label: "Twitter Integration",
      description: "URL to the [Twitter broadcast integration](https://api.aweber.com/#tag/Integrations) to use for this broadcast. When the broadcast is sent, the subject of the broadcast will be tweeted - **e.g. `https://api.aweber.com/1.0/accounts/<account_id>/integrations/<integration_id>`**.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.aweberApp.createBroadcast({
      $,
      accountId: this.accountId,
      listId: this.listId,
      data: {
        body_html: this.bodyHTML,
        body_text: this.bodyText,
        body_amp: this.bodyAmp,
        click_tracking_enabled: this.clickTrackingEnabled,
        exclude_lists: this.excludeLists,
        include_lists: this.includeLists,
        facebook_integration: this.facebookIntegration,
        is_archived: this.isArchived,
        notify_on_send: this.notifyOnSend,
        segment_link: this.segmentLink,
        subject: this.subject,
        twitter_integration: this.twitterIntegration,
      },
      headers: {
        "Content-Type": "application/x-www-form-urlencoded",
      },
    });

    $.export("$summary", `Successfully created broadcast with **UUID: ${response.uuid}**.`);
    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
AWeber	`aweberApp`	`app`	This component uses the AWeber app.
Account ID	`accountId`	`integer`	Select a value from the drop down menu.
List ID	`listId`	`string`	Select a value from the drop down menu.
Body HTML	`bodyHTML`	`string`	The content of the message in HTML format. If `Body Text` is not provided, it will be auto-generated. If `Body Text` is not provided, `Body HTML` must be provided.
Body Text	`bodyText`	`string`	The content of the message in plain text, used when HTML is not supported. If `Body HTML` is not provided, the broadcast will be sent using only the `Body Text`. If `Body Text` is not provided, `Body HTML` must be provided.
Body AMP	`bodyAmp`	`string`	The content of the message in AMP format. Read Aweber KB article before using this field
Click Tracking Enabled	`clickTrackingEnabled`	`boolean`	Enables links in the email message to be tracked.
Exclude Lists	`excludeLists`	`string[]`	Select a value from the drop down menu.
Include Lists	`includeLists`	`string[]`	Select a value from the drop down menu.
Facebook Integration	`facebookIntegration`	`string`	Select a value from the drop down menu.
Is Archived	`isArchived`	`boolean`	Whether the broadcast enabled sharing via an archive URL.
Notify on Send	`notifyOnSend`	`boolean`	If true, notify when stats are available on a sent broadcast message.
Segment Link	`segmentLink`	`string`	Select a value from the drop down menu.
Subject	`subject`	`string`	The broadcast subject line. Subject must not be empty nor contain only whitespace.
Twitter Integration	`twitterIntegration`	`string`	Select a value from the drop down menu.

Action Authentication#

AWeber uses OAuth authentication. When you connect your AWeber account, Pipedream will open a popup window where you can sign into AWeber and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any AWeber API.

Pipedream requests the following authorization scopes when you connect your account:

account.readlist.readlist.writesubscriber.readsubscriber.writesubscriber.read-extendedemail.reademail.write