Skip to content

14336 aweber #18738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

14336 aweber #18738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5af1965
Enhance Aweber component with new actions and updates
luancazarine Oct 13, 2025
76006bd
pnpm update
luancazarine Oct 13, 2025
44b6eb2
Fix typos in Aweber component descriptions and property names
luancazarine Oct 13, 2025
68a4918
Update readOnlyHint in create-broadcast action to allow editing
luancazarine Oct 13, 2025
5671e0d
Update create-broadcast action to make body HTML and body text optional
luancazarine Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/aweber/actions/add-subscriber/add-subscriber.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default {
name: "Add Subscriber",
description: "Add subscribers to the specified account and list. [See the docs here](https://api.aweber.com/#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/post).",
type: "action",
version: "0.0.4",
version: "0.0.5",
annotations: {
destructiveHint: false,
openWorldHint: true,
Expand Down
165 changes: 165 additions & 0 deletions components/aweber/actions/create-broadcast/create-broadcast.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
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 docs here](https://api.aweber.com/#tag/Broadcasts/paths/~1accounts~1%7BaccountId%7D~1lists~1%7BlistId%7D~1broadcasts/post).",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: "Create a broadcast under the specified account and list. [See the docs here](https://api.aweber.com/#tag/Broadcasts/paths/~1accounts~1%7BaccountId%7D~1lists~1%7BlistId%7D~1broadcasts/post).",
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,
},
Comment on lines +31 to +42
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Clarify the bodyHTML description and add runtime validation.

The description for bodyHTML (line 34) is self-contradictory: "If Body Text is not provided, it will be auto-generated. If Body Text is not provided, Body HTML must be provided." Both clauses start with the same condition but state different outcomes.

Additionally, as noted in a previous review, while both props are now optional, there's no validation in the run method to ensure at least one is provided before calling the API.

Apply this diff to clarify the description:

     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.",
+      description: "The content of the message in HTML format. If `Body Text` is not provided, it will be auto-generated from `Body HTML`. At least one of `Body HTML` or `Body Text` 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,
     },

Then add validation in the run method before the API call:

   async run({ $ }) {
+    if (!this.bodyHTML && !this.bodyText) {
+      throw new Error("At least one of 'Body HTML' or 'Body Text' must be provided.");
+    }
+
     const response = await this.aweberApp.createBroadcast({
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
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,
},
// Props
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 from `Body HTML`. At least one of `Body HTML` or `Body Text` 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,
},
// Run method
async run({ $ }) {
if (!this.bodyHTML && !this.bodyText) {
throw new Error("At least one of 'Body HTML' or 'Body Text' must be provided.");
}
const response = await this.aweberApp.createBroadcast({
// …existing parameters…
});
🤖 Prompt for AI Agents 
In components/aweber/actions/create-broadcast/create-broadcast.mjs around lines
31-42, the bodyHTML description is contradictory and there's no runtime check
ensuring at least one of bodyHTML or bodyText is provided; update the bodyHTML
description to clearly state that bodyHTML is optional, that either bodyHTML or
bodyText must be provided (and that if bodyHTML is omitted but bodyText exists
the HTML can be auto-generated), and in the run method add a validation early
(before calling the API) that throws or returns a clear error when both bodyHTML
and bodyText are missing so the action fails fast with a descriptive message.

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;
},
};
2 changes: 1 addition & 1 deletion components/aweber/actions/create-or-update-subscriber/create-or-update-subscriber.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export default {
name: "Create Or Update Subscriber",
description: "Create subscriber if the subscriber email is not existing or update the information for the specified subscriber by email. [See the docs here](https://api.aweber.com/#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/patch).",
type: "action",
version: "0.0.2",
version: "0.0.3",
annotations: {
destructiveHint: true,
openWorldHint: true,
Expand Down
2 changes: 1 addition & 1 deletion components/aweber/actions/get-accounts/get-accounts.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export default {
name: "Get Accounts",
description: "Get a paginated collection of accounts. [See the docs here](https://api.aweber.com/#tag/Accounts/paths/~1accounts/get).",
type: "action",
version: "0.0.4",
version: "0.0.5",
annotations: {
destructiveHint: false,
openWorldHint: true,
Expand Down
2 changes: 1 addition & 1 deletion components/aweber/actions/get-lists/get-lists.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export default {
name: "Get Lists",
description: "Get a paginated collection of subscriber lists. [See the docs here](https://api.aweber.com/#tag/Lists/paths/~1accounts~1{accountId}~1lists/get).",
type: "action",
version: "0.0.4",
version: "0.0.5",
annotations: {
destructiveHint: false,
openWorldHint: true,
Expand Down
2 changes: 1 addition & 1 deletion components/aweber/actions/get-subscribers/get-subscribers.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export default {
name: "Get Subscribers",
description: "Get a paginated collection of subscribers under the specified account and list. [See the docs here](https://api.aweber.com/#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/get).",
type: "action",
version: "0.0.4",
version: "0.0.5",
annotations: {
destructiveHint: false,
openWorldHint: true,
Expand Down
2 changes: 1 addition & 1 deletion components/aweber/actions/update-subscriber/update-subscriber.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default {
name: "Update Subscriber",
description: "Update the information for the specified subscriber by email. [See the docs here](https://api.aweber.com/#tag/Subscribers/paths/~1accounts~1{accountId}~1lists~1{listId}~1subscribers/patch).",
type: "action",
version: "0.0.3",
version: "0.0.4",
annotations: {
destructiveHint: true,
openWorldHint: true,
Expand Down
Loading
Loading