View as Markdown
AWeber icon

AWeber ACTION

Create Broadcast

Create a broadcast under the specified account and list. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's AWeber account once, then configure and run Create Broadcast from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "aweber-create-broadcast",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    aweber: { authProvisionId: "apn_xxxxxxx" },
    accountId: 10,
    listId: "List ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Broadcast inputs
Property Type Description
accountId Account ID integer
The account ID
Required Dynamic
listId List ID string
The list ID
Required Dynamic
bodyHTML Body HTML 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.
Optional
bodyText Body Text 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.
Optional
bodyAmp Body AMP string
The content of the message in AMP format. Read Aweber KB article before using this field
Optional
clickTrackingEnabled Click Tracking Enabled boolean
Enables links in the email message to be tracked.
Optional
excludeLists Exclude Lists string[]
List of 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 Dynamic
includeLists Include Lists string[]
List of 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 Dynamic
facebookIntegration Facebook Integration string
URL to the Facebook broadcast integration 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 Dynamic
isArchived Is Archived boolean
Whether the broadcast enabled sharing via an archive URL.
Optional
notifyOnSend Notify on Send boolean
If true, notify when stats are available on a sent broadcast message.
Optional
segmentLink Segment Link string
URL to the Segment to send this broadcast to. e.g. https://api.aweber.com/1.0/accounts/<account_id>/lists/<list_id>/segments/<segment_id>. If not specified, the broadcast will be sent to the “Active Subscribers” segment.
Optional Dynamic
subject Subject string
The broadcast subject line. Subject must not be empty nor contain only whitespace.
Required
twitterIntegration Twitter Integration string
URL to the Twitter broadcast integration 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 Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
aweber-create-broadcast
Version
0.0.2
App
AWeber
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes