Buttondown

Indie newsletter platform for writing, sending, and managing email lists.

1 trigger23 searches30 actionsInstant (webhooks)Auth: API key

AI-assisted documentation17 min read

This documentation is compiled from our integration source code, internal specs for Buttondown, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Buttondown on WEXTL →

Requirements

To use Buttondown on WEXTL you need an active account and an API access token from your account settings.[3]

Get your Buttondown credentials

ButtonDown - API KeypasswordRequired
You can find your API Key in your dashboard after you register: Button-down Dashboard.
[1]

Connect Buttondown in WEXTL

Log in to your WEXTL account, add the Buttondown node module to your workflow, and click Create new credential.
Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Buttondown account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting Buttondown to WEXTL® — Video slide demonstrates how to integrate Buttondown in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Buttondown in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Buttondown node modules

The list below is a reference of every Buttondown node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Open any Buttondown node module below to inspect its input parameters, outputs, and connection requirements.

Watch EventsTrigger

No fields documented.

Get a Bulk ActionAction

Input fields[3]

Field	Type
Bulk Action IDRequired	text

Output fields[3]

Field	Type
Creation date	text
Completion date	text
Bulk Action ID	text
Status	text
Type	text
Metadata	object
Ids	array

Get a CommentAction

Input fields[3]

Field	Type
Comment IDRequired	text

Output fields[3]

Field	Type
Comment ID	text
Creation date	text
Email ID	text
Subscriber ID	text
Parent ID	text
Text	text
Comment type	text
Annotation data	object
Subscriber	text
Email	text

Get a SubscriberAction

Input fields[3]

Field	Type
Subscriber ID or Email	choice
Expand Fields	array

Output fields[3]

Field	Type
Subscriber ID	text
Creation date	text
Email address	text
Notes	text
Metadata	object
Tags	array
Referrer URL	text
Secondary ID	number
Type	text
Source	text
Utm campaign	text
Utm medium	text
Utm source	text
Referral code	text
Avatar URL	text
Stripe coupon	text
Unsubscription date	text
Churn date	text
Undeliverability date	text
Undeliverability reason	text

11other output fields

Get a TagAction

Input fields[3]

Field	Type
Tag IDRequired	text

Output fields[3]

Field	Type
Tag Name	text
Color	text
Description	text
ID	text
Secondary ID	number
Creation date	text

Get an AccountAction

Output fields[3]

Field	Type
Username	text
Email address	email

Get an Email or DraftAction

Input fields[3]

Field	Type
Email IDRequired	choice

Output fields[3]

Field	Type
Email ID	text
Creation Date	date
Modification Date	date
Publish Date	date
Subject	text
Body	text
Status	text
Suppression Reason	text
Slug	text
Canonical URL	text
Email Type	text
Image	text
Description	text
Source	text
Secondary ID	number
Commenting Mode	text
Absolute URL	text
Filters (rules)	array
Filters (groups)	array
Filters Predicate	text

23other output fields

Get Email AnalyticsAction

Input fields[3]

Field	Type
Email IDRequired	choice

Output fields[3]

Field	Type
Recipients	number
Deliveries	number
Opens	number
Clicks	number
Temporary Failures	number
Permanent Failures	number
Unsubscriptions	number
Complaints	number
Survey Responses	number
Webmentions	number
Page Views (Lifetime)	number
Page Views (30 days)	number
Page Views (7 days)	number
Subscriptions	number
Paid Subscriptions	number
Replies	number
Comments	number
Social Mentions	number

Get Email Historical BodyAction

Input fields[3]

Field	Type
Email ID	choice
History Entry IDRequired	text
Expand Fields	array

Output fields[3]

Field	Type
History ID	number
Creation date	text
Value	text
User ID	text
User	text

Get Email HistorySearch

Input fields[3]

Field	Type
Email IDRequired	choice
FieldsRequired	choice
Search Query	text
Expand Fields	array
Limit	number
Ordering	choice

Output fields[3]

Field	Type
History ID	number
Creation date	text
Value	text
User ID	text
User	text

Get ExportAction

Input fields[3]

Field	Type
Export IDRequired	text

Output fields[3]

Field	Type
Collections	array
Parameters	text
Format	text
Columns	text
Export ID	text
Creation date	text
URL	text
Completion date	text
Status	text

List AttachmentsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Attachment ID	text
Creation date	text
Name	text
File	text

List CommentsSearch

Input fields[3]

Field	Type
Comment Type	choice
Email ID	text
Subscriber ID	text
Expand	choice
Ordering	choice
Limit	number

Output fields[3]

Field	Type
Comment ID	text
Creation date	text
Email ID	text
Subscriber ID	text
Parent ID	text
Text	text
Comment type	text
Annotation data	object
Subscriber	text
Email	text

List CouponsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Coupon ID	text
Percent off	text
Amount off	text
Name	text

List EmailsSearch

Input fields[3]

Field	Type
Email IDS	array
Email Status	choice
Email Type	choice
Subject Contains	text
Order By	choice
Limit	number

Output fields[3]

Field	Type
Email ID	text
Creation Date	date
Modification Date	date
Publish Date	date
Subject	text
Body	text
Status	text
Suppression Reason	text
Slug	text
Canonical URL	text
Email Type	text
Image	text
Description	text
Source	text
Secondary ID	number
Commenting Mode	text
Absolute URL	text
Filters (rules)	array
Filters (groups)	array
Filters Predicate	text

23other output fields

List EventsSearch

Input fields[3]

Field	Type
Event TypeRequired	choice
Ordering	choice
Expand	array
Email ID	text
Automation ID	text
Subscriber ID	text
Maximum Results	number

Output fields[3]

Field	Type
Event ID	text
Subscriber ID	text
Email ID	text
Automation ID	text
Creation date	text
Metadata	object
Event type	text
Subscriber	text
Email	text
Automation	text

List External FeedsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
External Feed ID	text
Creation date	text
Last checked date	text
Status	text
Behavior	text
Cadence	text
Cadence metadata	object
Filters	object
Filters	array
Groups	array
Predicate	text
URL	text
Subject	text
Body	text
Label	text
Metadata	object
Skip old items	boolean

List ImagesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Creation date	date
Image ID	text
Image URL	url

List NewslettersSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Newsletter ID	text
Username	text
Name	text
Description	text
Creation date	text
API key	text
Tint color	text
From name	text
Header	text
Footer	text
Domain	text
Email domain	text
Enabled features	array
Custom email template	text
CSS	text
Web CSS	text
Icon	text
Image	text
Auditing mode	text

List NotesSearch

Input fields[3]

Field	Type
Model Type	choice
Model ID	text
Expand	array
Limit	number

Output fields[3]

Field	Type
Note ID	text
Creation date	text
Body	text
Model type	text
Model ID	text
Metadata	object
User ID	text
User	text

List SubscribersSearch

Input fields[3]

Field	Type
Email Address	text
Subscriber Type	choice
Source	choice
Limit	number

Output fields[3]

Field	Type
subscriber ID	text
Creation date	text
Email address	text
Notes	text
Metadata	object
Tags	array
Referrer URL	text
Secondary ID	number
Type	text
Source	text
Utm campaign	text
Utm medium	text
Utm source	text
Referral code	text
Avatar URL	text
Stripe coupon	text
Unsubscription date	text
Churn date	text
Undeliverability date	text
Undeliverability reason	text

11other output fields

List Survey ResponsesSearch

Input fields[3]

Field	Type
Email	text
Subscriber ID	text
Survey ID	array
Start Date	date
End Date	date
Expand	array
Limit	number

Output fields[3]

Field	Type
Survey ID	text
Creation date	text
Answer	text
Text	text
Survey ID	text
Subscriber ID	text
Email ID	text
Automation ID	text
Subscriber	text
Survey	text
Email	text
Automation	text

List SurveysSearch

Input fields[3]

Field	Type
Status	choice
Exclude Status	choice
Limit	number

Output fields[3]

Field	Type
Survey ID	text
Creation date	text
Identifier	text
Question	text
Response count	number
Answers	array
Notes	text
Response cadence	text
Status	text
Is freeform response enabled	boolean

Create a Bulk ActionAction

Input fields[3]

Field	Type
Bulk Action TypeRequired	choice
MetadataRequired	text

Output fields[3]

Field	Type
Creation date	text
Completion date	text
ID	text
Status	text
Type	text
Metadata	object
Ids	array

Create a Confirmation ReminderAction

Input fields[3]

Field	Type
Subscriber ID or EmailRequired	choice

Output fields[3]

Field	Type
Success	boolean
Message	text
Raw Response	text

Create a Draft EmailAction

Input fields[3]

Field	Type
Email IDRequired	choice
Subscribers	array
Subscriber ID	choice
Recipients	array
Recipient Email	email

Output fields[3]

Field	Type
Email ID	text
Subscribers	array
Recipients	array

Create a Finalized EmailAction

Input fields[3]

Field	Type
Subscriber ID or EmailRequired	choice
Email IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Message	text
Raw Response	text

Create a NewsletterAction

Input fields[3]

Field	Type
UsernameRequired	text
Newsletter NameRequired	text
DescriptionRequired	text
Tint Color	text
From Name	text
Header	text
Footer	text
Domain	text
Email Domain	text
Enabled Features	array
Custom Email Template	text
Custom CSS (Emails)	text
Custom CSS (Web)	text
Icon URL	text
Header Image URL	text

Output fields[3]

Field	Type
Newsletter ID	text
Username	text
Name	text
Description	text
Creation date	text
API key	text
Tint color	text
From name	text
Header	text
Footer	text
Domain	text
Email domain	text
Enabled features	array
Custom email template	text
CSS	text
Web CSS	text
Icon	text
Image	text
Auditing mode	text

Create a NoteAction

Input fields[3]

Field	Type
Note BodyRequired	text
Model TypeRequired	choice
Model IDRequired	text
Metadata	text

Output fields[3]

Field	Type
Note ID	text
Creation date	text
Body	text
Model type	text
Model ID	text
Metadata	object
User ID	text
User	text

Create a SubscriberAction

Input fields[3]

Field	Type
Email AddressRequired	text
Subscriber Type	choice
Source	choice
Notes	text
Name	text
Tags	array
IP Address	text

Output fields[3]

Field	Type
Subscriber ID	text
Creation date	text
Email address	text
Notes	text
Metadata	object
Last name	text
First name	text
Subscription plan	text
Tags	array
Referrer URL	text
Secondary ID	number
Type	text
Source	text
Utm campaign	text
Utm medium	text
Utm source	text
Referral code	text
Avatar URL	text
Stripe coupon	text
Unsubscription date	text
Churn date	text
Undeliverability date	text
Undeliverability reason	text

11other output fields

Create a SurveyAction

Input fields[3]

Field	Type
Survey IdentifierRequired	text
Survey QuestionRequired	text
Possible AnswersRequired	array
Notes	text
Allow Freeform Responses	boolean
Response Cadence	choice

Output fields[3]

Field	Type
Survey ID	text
Creation date	text
Identifier	text
Question	text
Response count	number
Answers	array
Notes	text
Response cadence	text
Status	text
Is freeform response enabled	boolean

Create a TagAction

Input fields[3]

Field	Type
Tag NameRequired	text
Color(Hex Code)Required	text
Description	text

Output fields[3]

Field	Type
Tag Name	text
Color	text
Description	text
ID	text
Secondary ID	number
Creation date	text

Create an AttachmentAction

Input fields[3]

Field	Type
Attachment FileRequired	text
Attachment Name	text

Output fields[3]

Field	Type
Attachment ID	text
Creation date	text
Name	text
File	text

Create an EmailAction

Input fields[3]

Field	Type
Email SubjectRequired	text
Email BodyRequired	text
Email Status	choice
Publish Date	date
Attachments	array
Name	text
Slug	text
Email Type	choice
Commenting Mode	choice
Related Email IDs	array
Featured	boolean
Trigger Pay-Per-Email Billing	boolean
Description	text
Canonical URL	text
Image URL	text
Secondary ID	number
Audience Filters	choice

Output fields[3]

Field	Type
Email ID	text
Creation date	text
Modification date	text
Publish date	text
Subject	text
Body	text
Status	text
Suppression reason	text
Slug	text
Canonical URL	text
Email type	text
Image	text
Description	text
Metadata	object
Source	text
Secondary ID	text
Commenting mode	text
Absolute URL	text
Filters	object
Filters	array
Groups	array
Predicate	text
Analytics	text

5other output fields

Create an ExportAction

Input fields[3]

Field	Type
Export CollectionsRequired	choice
Parameters	text
Export Format	choice
Columns	array

Output fields[3]

Field	Type
Collections	array
Parameters	text
Format	text
Columns	text
Export ID	text
Creation date	text
URL	text
Completion date	text
Status	text

Create an External FeedAction

Input fields[3]

Field	Type
RSS Feed URLRequired	text
Email SubjectRequired	text
Email BodyRequired	text
Feed LabelRequired	text
Behavior	choice
Cadence	choice
Cadence Metadata	text
Filters	text
Metadata	text
Skip Old Items	boolean

Output fields[3]

Field	Type
External Feed ID	text
Creation date	text
Last checked date	text
Status	text
Behavior	text
Cadence	text
Cadence metadata	object
Filters	object
Filters	array
Groups	array
Predicate	text
URL	text
Subject	text
Body	text
Label	text
Metadata	object
Skip old items	boolean

Create an ImageAction

Input fields[3]

Field	Type
Upload ImageRequired	text

Output fields[3]

Field	Type
Creation date	text
Image ID	text
Image	text

Delete a NewsletterAction

Input fields[3]

Field	Type
Newsletter IDRequired	number

Delete a NoteAction

Input fields[3]

Field	Type
Note IDRequired	text

Delete a SubscriberAction

Input fields[3]

Field	Type
Subscriber ID or EmailRequired	choice

Delete a SurveyAction

Input fields[3]

Field	Type
Survey IDRequired	text

Delete a TagAction

Input fields[3]

Field	Type
Tag IDRequired	text

Delete a WebhookAction

Input fields[3]

Field	Type
Webhook IDRequired	text

Delete an AttachmentAction

Input fields[3]

Field	Type
Attachment IDRequired	text

Delete an External FeedAction

Input fields[3]

Field	Type
External Feed IDRequired	text

Delete an ImageAction

Input fields[3]

Field	Type
Image IDRequired	text

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Update a NewsletterAction

Input fields[3]

Field	Type
Newsletter ID	text
Username	text
Newsletter Name	text
Description	text
Tint Color	text
From Name	text
Header	text
Footer	text
Domain	text
Email Domain	text
Enabled Features	array
Custom Email Template	text
Custom CSS (Emails)	text
Custom CSS (Web)	text
Icon URL	text
Header Image URL	text

Output fields[3]

Field	Type
Newsletter ID	text
Username	text
Name	text
Description	text
Creation date	text
API key	text
Tint color	text
From name	text
Header	text
Footer	text
Domain	text
Email domain	text
Enabled features	array
Custom email template	text
CSS	text
Web CSS	text
Icon	text
Image	text
Auditing mode	text

Update a SubscriberAction

Input fields[3]

Field	Type
Subscriber ID or EmailRequired	choice
Email Address	text
Notes	text
Name	text
Tags	array
Referrer URL	text
Subscriber Type	choice
Unsubscription Reason	text

Update a SurveyAction

Input fields[3]

Field	Type
Survey IDRequired	text
Survey Identifier	text
Survey Question	text
Possible Answers	array
Notes	text
Allow Freeform Responses	boolean
Response Cadence	choice

Output fields[3]

Field	Type
Survey ID	text
Creation date	text
Identifier	text
Question	text
Response count	number
Answers	array
Notes	text
Response cadence	text
Status	text
Is freeform response enabled	boolean

Update a TagAction

Input fields[3]

Field	Type
Tag NameRequired	text
Color(Hex Code)Required	text
Description	text
Secondary ID	number

Output fields[3]

Field	Type
Tag Name	text
Color	text
Description	text
ID	text
Secondary ID	number
Creation date	text

Update an Email or a DraftAction

Input fields[3]

Field	Type
Email IDRequired	choice
Subject	text
Body (HTML or Markdown)	text
Email Type	choice
Status	choice
Related Email IDs	array
Name	text
Slug	text
Canonical URL	text
Description	text
Publish Date	date
Suppression Reason	text
Metadata (JSON)	text
Image URL	text
Commenting Mode	choice
Attachments	text
Featured?	boolean
Trigger Pay-Per-Email Billing?	boolean

Output fields[3]

Field	Type
Email ID	text
Creation date	text
Modification date	text
Publish date	text
Subject	text
Body	text
Status	text
Suppression reason	text
Slug	text
Canonical URL	text
Email type	text
Image	text
Description	text
Metadata	object
Source	text
Secondary ID	text
Commenting mode	text
Absolute URL	text
Filters	object
Filters	array
Groups	array
Predicate	text
Analytics	text

5other output fields

Update an External FeedAction

Input fields[3]

Field	Type
External Feed IDRequired	text
RSS Feed URL	text
Email Subject	text
Email Body	text
Feed Label	text
Behavior	choice
Cadence	choice
Cadence Metadata	text
Filters	text
Metadata	text
Skip Old Items	boolean

Output fields[3]

Field	Type
External Feed ID	text
Creation date	text
Last checked date	text
Status	text
Behavior	text
Cadence	text
Cadence metadata	object
Filters	object
Filters	array
Groups	array
Predicate	text
URL	text
Subject	text
Body	text
Label	text
Metadata	object
Skip old items	boolean

Templates

Look for Buttondown templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Communication category →

References

WEXTL® Buttondown Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Buttondown.
WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:38

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.