About this integration
Publish newsletters and manage subscribers in beehiiv.
There are 11 triggers, 57 search modules and 38 actions available. The integration connects via oauth authentication.
How to connect
The credential form asks for Client ID and Client Secret.
OAuth asks you to approve identify:read, publications:read, and posts:read before access is granted.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | Your OAuth application Client ID (uid). Create an OAuth app in your workspace under Settings > Integrations > API. |
Client SecretRequired | password | Your OAuth application Client Secret, issued alongside the Client ID when you create your OAuth app. |
Permissions requested
- identify:read
- publications:read
- posts:read
- posts:write
- subscriptions:read
- subscriptions:write
- automations:read
- automations:write
- custom_fields:read
- custom_fields:write
- segments:read
- segments:write
- tiers:read
- tiers:write
- polls:read
- podcasts:read
- newsletter_lists:read
- newsletter_lists:write
- complimentary_access:read
- condition_sets:read
- data_deletion:read
- data_deletion:write
- referral_program:read
Use it in workflow automation
Start with Watch Automation Emails, then add Accept Ad Offer.
Triggers, searches and actions
Open any beehiiv trigger, search, or action to see its inputs and outputs — 11 triggers, 57 searchs, 38 actions.
Triggers
Use one of 11 triggers to kick off a workflow as soon as an event occurs in the app.
- Watch Automation Emails
- Watch Condition Sets
- Watch Data Deletion Requests
- Watch Email Blasts
- Watch Newsletter Lists
6more triggers
Searches
This integration includes 57 search modules for looking data up mid-run.
- Get Account Ad Network Report Summary
- Get Ad Network Reports
- Get Ad Network Report Summary
- Get Ad Offer Advertisements
- Get Ad Offers
52more searches
Actions
Take action during a run with 38 available modules that write data back into the app.
- Accept Ad Offer
- Add Subscription Tag
- Add Subscription to an Automation
- Bulk Create Subscription
- Create a Tier
33more actions
Explore the fields available for each beehiiv trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
ID | text |
Automation Step ID | text |
Subject Line | text |
Preview Text | text |
Status | text |
First Sent At | number |
Last Sent At | number |
Created At | date |
Stats | object |
Email | object |
Clicks | array |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Created | date |
Updated | date |
Purpose | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | text |
Status | text |
Source | text |
Requested At | text |
Scheduled For Processing At | text |
Completed At | date |
Created At | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | date |
Last Sent | date |
Status | text |
Subject Line | text |
Preview Text | text |
Stats | object |
Email | object |
Clicks | array |
Content | object |
Email | object |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Slug | text |
Description | text |
Status | text |
Auto Subscribe | boolean |
Subscriber Count | number |
Created At | date |
Updated At | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Newsletter List ID | text |
Subscription ID | text |
Status | text |
Subscribed At | number |
Unsubscribed At | number |
Created At | date |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | date |
Slug | text |
Description | text |
Categories | array |
Categorie | text |
Artwork URL | text |
Status | text |
Language | text |
Title | text |
Author | text |
Type | text |
6other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Question | text |
Description | text |
Poll Type | text |
Status | text |
Created At | date |
Poll Choices | array |
ID | text |
Label | text |
Trivia Answer | text |
Stats | object |
Completions | number |
Vote Counts | object |
Total Responses | number |
1other output field
Output fields
| Field | Type |
|---|---|
ID | text |
Subtitle | text |
Title | text |
Authors | array |
Author | text |
Created | date |
Status | text |
Publish Date | date |
Displayed Date | date |
Split Tested | boolean |
Subject Line | text |
Preview Text | text |
20other output fields
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Organization Name | text |
Referral Program Enabled | boolean |
Created | date |
Stats | object |
Active Subscriptions | text |
Active Premium Subscriptions | text |
Active Free Subscriptions | text |
Average Open Rate | text |
Average Click Rate | text |
Total Sent | text |
Total Unique Opened | text |
Total Clicked | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | date |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Searches
Input fields
| Field | Type |
|---|---|
Start_date | text |
End_date | text |
Output fields
| Field | Type |
|---|---|
Publication ID | text |
Opens | number |
Verified Clicks | number |
Revenue | text |
Oda | object |
Opens | number |
Verified Clicks | number |
Revenue | text |
Programmatic | object |
Opens | number |
Verified Clicks | number |
Revenue | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Start_date | text |
End_date | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Publication ID | text |
Post ID | text |
Ad Link ID | text |
Opens | number |
Verified Clicks | number |
Revenue | text |
Is Programmatic | boolean |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Start_date | text |
End_date | text |
Output fields
| Field | Type |
|---|---|
Publication ID | text |
Opens | number |
Verified Clicks | number |
Revenue | text |
Oda | object |
Opens | number |
Verified Clicks | number |
Revenue | text |
Programmatic | object |
Opens | number |
Verified Clicks | number |
Revenue | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
Advertisements | array |
ID | text |
Recommended | boolean |
Name | text |
Headline | text |
Description | text |
Kind | text |
Sponsor Text | text |
Text | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Requested_from | text |
Output fields
| Field | Type |
|---|---|
Offers | array |
ID | text |
Payout Model | text |
Payout Per Click | text |
Payout Per Mille | text |
Estimated Payout | text |
Send By | date |
Campaign | object |
Advertiser | object |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Advertiser Name | text |
Payout Rate | text |
Advertisement Kind | text |
Send By Window Start At | number |
Send By Window End At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Audience | choice |
Platform | choice |
Status | choice |
Content_tags | array |
Content_tags | text |
Authors | array |
Authors | text |
Hidden_from_feed | choice |
Output fields
| Field | Type |
|---|---|
Stats | object |
Email | object |
Web | object |
Clicks | array |
Upgrades | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Bio | text |
Bio Image URL | text |
Social Media Links | object |
Twitter Handle | text |
Facebook URL | text |
Instagram URL | text |
Linkedin URL | text |
Youtube URL | text |
Tiktok URL | text |
Discord URL | text |
Bluesky URL | text |
RSS URL | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Status | text |
Name | text |
Trigger Events | array |
Trigger Event | text |
Description | text |
Stats | object |
Journeys | object |
Email | object |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Automation ID | text |
Subscription ID | text |
Email | text |
Status | text |
Started At | number |
Completed At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Duration | number |
Time Unit | text |
Description | text |
Tier ID | text |
Tier | object |
ID | text |
Name | text |
Status | text |
Description | text |
Stats | object |
Prices | array |
Stats | object |
Total Granted | number |
Active Granted | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Created | number |
Updated | number |
Purpose | text |
Stats | object |
Active Subscriber Count | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Kind | text |
Display | text |
Created | number |
Options | array |
Option | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | text |
Status | text |
Source | text |
Requested At | text |
Scheduled For Processing At | text |
Completed At | text |
Created At | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | number |
Last Sent | number |
Status | text |
Subject Line | text |
Preview Text | text |
Stats | object |
Email | object |
Clicks | array |
Content | object |
Email | object |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Slug | text |
Description | text |
Status | text |
Auto Subscribe | boolean |
Subscriber Count | number |
Created At | number |
Updated At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Newsletter List ID | text |
Subscription ID | text |
Status | text |
Subscribed At | number |
Unsubscribed At | number |
Created At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | number |
Slug | text |
Description | text |
Categories | array |
Categorie | text |
Artwork URL | text |
Status | text |
Language | text |
Title | text |
Author | text |
Type | text |
6other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | number |
Updated | number |
Title | text |
Slug | text |
Publish Date | number |
Displayed Date | number |
Duration | number |
Description | text |
Show Notes | text |
Artwork URL | text |
6other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Question | text |
Description | text |
Poll Type | text |
Status | text |
Created At | number |
Poll Choices | array |
ID | text |
Label | text |
Trivia Answer | text |
Stats | object |
Completions | number |
Vote Counts | object |
Total Responses | number |
1other output field
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Premium_tiers | array |
Output fields
| Field | Type |
|---|---|
ID | text |
Subtitle | text |
Title | text |
Authors | array |
Author | text |
Created | number |
Status | text |
Publish Date | number |
Displayed Date | number |
Split Tested | boolean |
Subject Line | text |
Preview Text | text |
20other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Order | choice |
Order_by | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Organization Name | text |
Referral Program Enabled | boolean |
Created | number |
Stats | object |
Active Subscriptions | text |
Active Premium Subscriptions | text |
Active Free Subscriptions | text |
Average Open Rate | text |
Average Click Rate | text |
Total Sent | text |
Total Unique Opened | text |
Total Clicked | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Start_date | text |
Number_of_days | number |
Granularity | choice |
Email_type | choice |
Direction | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Date | date |
Total Opens | number |
Unique Opens | number |
Total Clicks | number |
Total Verified Clicks | number |
Unique Clicks | number |
Unique Verified Clicks | number |
Input fields
| Field | Type |
|---|---|
EmailRequired | |
Expand | array |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Auto Fulfill | boolean |
Num Referrals | number |
Reward | object |
ID | text |
Name | text |
Description | text |
Image URL | text |
Type | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Last Calculated | number |
Total Results | number |
Status | text |
Active | boolean |
Stats | object |
Open Rate | number |
Total Sent | number |
Percentage Premium Subscribers | number |
Percentage Subscribers With Referrals | number |
Unique Emails Clicked | number |
Total Delivered | number |
Total Referrals | number |
Unsubscribed Rate | number |
Total Subscribers | number |
Clickthrough Rate | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
EmailRequired | |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
JWT Token | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
Params | text |
Status | text |
Publication ID | text |
Failure Reason | text |
Completed | number |
Created | number |
Updated | number |
Error Log | array |
Error Log | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Description | text |
Stats | object |
Active Subscriptions | number |
Prices | array |
ID | text |
Currency | text |
Amount Cents | number |
Enabled | boolean |
Interval | text |
Denominator | text |
CTA | text |
Features | array |
No fields documented.
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Name | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Bio | text |
Bio Image URL | url |
Social Media Links | object |
Twitter Handle | text |
Facebook URL | url |
Instagram URL | url |
Linkedin URL | url |
Youtube URL | url |
Tiktok URL | url |
Discord URL | url |
Bluesky URL | url |
RSS URL | url |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Automation Step ID | text |
Subject Line | text |
Preview Text | text |
Status | text |
First Sent At | number |
Last Sent At | date |
Created At | date |
Stats | object |
Email | object |
Clicks | array |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Status | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Automation ID | text |
Subscription ID | text |
Email | text |
Status | text |
Started At | date |
Completed At | date |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Status | text |
Name | text |
Trigger Events | array |
Trigger Event | text |
Description | text |
Stats | object |
Journeys | object |
Email | object |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Duration | number |
Time Unit | text |
Description | text |
Tier ID | text |
Tier | object |
ID | text |
Name | text |
Status | text |
Description | text |
Stats | object |
Prices | array |
Stats | object |
Total Granted | number |
Active Granted | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Purpose | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Created | date |
Updated | date |
Purpose | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Kind | text |
Display | text |
Created | date |
Options | array |
Option | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | text |
Status | text |
Source | text |
Requested At | text |
Scheduled For Processing At | text |
Completed At | text |
Created At | date |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Status | choice |
Order_by | choice |
Direction | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | date |
Last Sent | date |
Status | text |
Subject Line | text |
Preview Text | text |
Stats | object |
Email | object |
Clicks | array |
Content | object |
Email | object |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Direction | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Slug | text |
Description | text |
Status | text |
Auto Subscribe | boolean |
Subscriber Count | number |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Direction | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Newsletter List ID | text |
Subscription ID | text |
Status | text |
Subscribed At | number |
Unsubscribed At | number |
Created At | date |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Status | choice |
Order_by | choice |
Direction | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | date |
Updated | date |
Title | text |
Slug | text |
Publish Date | number |
Displayed Date | number |
Duration | number |
Description | text |
Show Notes | text |
Artwork URL | text |
6other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Status | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Created | date |
Slug | text |
Description | text |
Categories | array |
Categorie | text |
Artwork URL | text |
Status | text |
Language | text |
Title | text |
Author | text |
Type | text |
6other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Order_by | choice |
Direction | choice |
Expand | array |
Expand | text |
Post_id | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Subscription ID | text |
Subscription Deleted | boolean |
Poll Choice ID | text |
Poll Choice Label | text |
Created At | date |
Extended Feedback | text |
Post ID | text |
Post Title | text |
Post Publish Date | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Order_by | choice |
Direction | choice |
Expand | array |
Expand | text |
Post_id | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Question | text |
Description | text |
Poll Type | text |
Status | text |
Created At | date |
Poll Choices | array |
ID | text |
Label | text |
Trivia Answer | text |
Stats | object |
Completions | number |
Vote Counts | object |
Total Responses | number |
1other output field
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Audience | choice |
Platform | choice |
Status | choice |
Content_tags | array |
Content_tags | text |
Slugs | array |
Slugs | text |
Authors | array |
Authors | text |
Premium_tiers | array |
Order_by | choice |
Direction | choice |
2other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Subtitle | text |
Title | text |
Authors | array |
Author | text |
Created | date |
Status | text |
Publish Date | date |
Displayed Date | date |
Split Tested | boolean |
Subject Line | text |
Preview Text | text |
20other output fields
Input fields
| Field | Type |
|---|---|
Expand | array |
Direction | choice |
Order_by | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Organization Name | text |
Referral Program Enabled | boolean |
Created | date |
Stats | object |
Active Subscriptions | text |
Active Premium Subscriptions | text |
Active Free Subscriptions | text |
Average Open Rate | text |
Average Click Rate | text |
Total Sent | text |
Total Unique Opened | text |
Total Clicked | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Type | choice |
Status | choice |
Order_by | choice |
Direction | choice |
Expand | array |
Expand | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Last Calculated | number |
Total Results | number |
Status | text |
Active | boolean |
Stats | object |
Open Rate | number |
Total Sent | number |
Percentage Premium Subscribers | number |
Percentage Subscribers With Referrals | number |
Unique Emails Clicked | number |
Total Delivered | number |
Total Referrals | number |
Unsubscribed Rate | number |
Total Subscribers | number |
Clickthrough Rate | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Subscription ID | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | date |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Status | choice |
Tier | choice |
Premium_tiers | array |
Premium_tiers | text |
Premium_tier_ids | array |
Premium_tier_ids | text |
Email | text |
Order_by | choice |
Direction | choice |
Creation_date | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | date |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Type | text |
Params | text |
Status | text |
Publication ID | text |
Failure Reason | text |
Completed | number |
Created | date |
Updated | date |
Error Log | array |
Error Log | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Expand | array |
Expand | text |
Direction | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Description | text |
Stats | object |
Active Subscriptions | number |
Prices | array |
ID | text |
Currency | text |
Amount Cents | number |
Enabled | boolean |
Interval | text |
Denominator | text |
CTA | text |
Features | array |
Actions
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Offer_idRequired | text |
Advertisement_idRequired | text |
Post_idRequired | text |
Output fields
| Field | Type |
|---|---|
Offer ID | text |
Opportunity ID | text |
Advertisement ID | text |
Post ID | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Tags | array |
Tag | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Email | text |
Subscription_id | text |
Double_opt_override | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Automation ID | text |
Subscription ID | text |
Email | text |
Status | text |
Started At | number |
Completed At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
SubscriptionsRequired | array |
EmailRequired | text |
Reactivate_existing | boolean |
Send_welcome_email | boolean |
Utm_source | text |
Utm_medium | text |
Utm_campaign | text |
Utm_term | text |
Utm_content | text |
Referring_site | text |
Referral_code | text |
Output fields
| Field | Type |
|---|---|
Message | text |
Import ID | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
NameRequired | text |
Description | text |
Prices_attributes | array |
CurrencyRequired | choice |
Amount_centsRequired | number |
Enabled | boolean |
IntervalRequired | choice |
Interval_display | text |
Cta | text |
Features | array |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Description | text |
Stats | object |
Active Subscriptions | number |
Prices | array |
ID | text |
Currency | text |
Amount Cents | number |
Enabled | boolean |
Interval | text |
Denominator | text |
CTA | text |
Features | array |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
KindRequired | choice |
DisplayRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Kind | text |
Display | text |
Created | number |
Options | array |
Option | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
EmailRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | text |
Status | text |
Source | text |
Requested At | text |
Scheduled For Processing At | text |
Completed At | text |
Created At | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
NameRequired | text |
Description | text |
Slug | text |
Auto_subscribe | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Slug | text |
Description | text |
Status | text |
Auto Subscribe | boolean |
Subscriber Count | number |
Created At | number |
Updated At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Subscription_id | text |
Email | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Newsletter List ID | text |
Subscription ID | text |
Status | text |
Subscribed At | number |
Unsubscribed At | number |
Created At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Blocks | array |
Block | text |
Body_content | text |
TitleRequired | text |
Subtitle | text |
Post_template_id | text |
Status | choice |
Scheduled_at | date |
Custom_link_tracking_enabled | boolean |
Email_capture_type_override | choice |
Override_scheduled_at | date |
12other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Preview URL | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
NameRequired | text |
InputRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Type | text |
Last Calculated | number |
Total Results | number |
Status | text |
Active | boolean |
Stats | object |
Open Rate | number |
Total Sent | number |
Percentage Premium Subscribers | number |
Percentage Subscribers With Referrals | number |
Unique Emails Clicked | number |
Total Delivered | number |
Total Referrals | number |
Unsubscribed Rate | number |
Total Subscribers | number |
Clickthrough Rate | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
EmailRequired | text |
Reactivate_existing | boolean |
Send_welcome_email | boolean |
Utm_source | text |
Utm_medium | text |
Utm_campaign | text |
Utm_term | text |
Utm_content | text |
Referring_site | text |
Referral_code | text |
10other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Platform | text |
Subscriber_type | text |
Tier_ids | array |
Subscriber_id | text |
Output fields
| Field | Type |
|---|---|
Preview URL | text |
Output fields
| Field | Type |
|---|---|
First Name | text |
Last Name | text |
Email | text |
Profile Picture | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Owner Email | text |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Output fields
| Field | Type |
|---|---|
Message | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Recipient_emailsRequired | array |
Recipient_email | text |
Output fields
| Field | Type |
|---|---|
Remaining Test Sends | number |
Reset At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Name | text |
Description | text |
Prices_attributes | array |
IdRequired | choice |
CurrencyRequired | choice |
Amount_centsRequired | number |
IntervalRequired | choice |
Interval_display | text |
Cta | text |
Features | array |
Delete | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Description | text |
Stats | object |
Active Subscriptions | number |
Prices | array |
ID | text |
Currency | text |
Amount Cents | number |
Enabled | boolean |
Interval | text |
Denominator | text |
CTA | text |
Features | array |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Name | text |
Description | text |
Prices_attributes | array |
IdRequired | choice |
CurrencyRequired | choice |
Amount_centsRequired | number |
IntervalRequired | choice |
Interval_display | text |
Cta | text |
Features | array |
Delete | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Status | text |
Description | text |
Stats | object |
Active Subscriptions | number |
Prices | array |
ID | text |
Currency | text |
Amount Cents | number |
Enabled | boolean |
Interval | text |
Denominator | text |
CTA | text |
Features | array |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Display | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Kind | text |
Display | text |
Created | number |
Options | array |
Option | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Display | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Kind | text |
Display | text |
Created | number |
Options | array |
Option | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Name | text |
Description | text |
Slug | text |
Auto_subscribe | boolean |
Status | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Slug | text |
Description | text |
Status | text |
Auto Subscribe | boolean |
Subscriber Count | number |
Created At | number |
Updated At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Unsubscribe | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Newsletter List ID | text |
Subscription ID | text |
Status | text |
Subscribed At | number |
Unsubscribed At | number |
Created At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Unsubscribe | boolean |
Output fields
| Field | Type |
|---|---|
ID | text |
Newsletter List ID | text |
Subscription ID | text |
Status | text |
Subscribed At | number |
Unsubscribed At | number |
Created At | number |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Content_merge_strategy | choice |
Blocks | array |
Block | text |
Body_content | text |
Title | text |
Subtitle | text |
Scheduled_at | date |
Custom_link_tracking_enabled | boolean |
Email_capture_type_override | choice |
Override_scheduled_at | date |
Social_share | choice |
11other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Subtitle | text |
Title | text |
Authors | array |
Author | text |
Created | number |
Status | text |
Publish Date | number |
Displayed Date | number |
Split Tested | boolean |
Subject Line | text |
Preview Text | text |
20other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
EmailRequired | |
Tier | choice |
Premium_tier_ids | array |
Premium_tier_id | text |
Premium_tiers | array |
Premium_tier | text |
Stripe_customer_id | text |
Unsubscribe | boolean |
Custom_fields | array |
Name | text |
Value | text |
Delete | boolean |
Complimentary_gift_id | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Tier | choice |
Premium_tier_ids | array |
Premium_tier_id | text |
Premium_tiers | array |
Premium_tier | text |
Email | text |
Stripe_customer_id | text |
Unsubscribe | boolean |
Custom_fields | array |
Name | text |
Value | text |
Delete | boolean |
Complimentary_gift_id | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Email | text |
Tier | choice |
Premium_tier_ids | array |
Premium_tier_id | text |
Premium_tiers | array |
Premium_tier | text |
Stripe_customer_id | text |
Unsubscribe | boolean |
Custom_fields | array |
Name | text |
Value | text |
Delete | boolean |
Complimentary_gift_id | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Email | |
Status | text |
Created | number |
Subscription Tier | text |
Subscription Premium Tier Names | array |
Subscription Premium Tier Name | text |
UTM Source | text |
UTM Medium | text |
UTM Channel | text |
UTM Campaign | text |
UTM Term | text |
8other output fields
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Subscriptions | array |
Subscription_idRequired | text |
Tier | choice |
Stripe_customer_id | text |
Unsubscribe | boolean |
Custom_fields | array |
Complimentary_gift_id | text |
Output fields
| Field | Type |
|---|---|
Subscription Update ID | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Subscriptions | array |
Subscription_idRequired | text |
Tier | choice |
Stripe_customer_id | text |
Unsubscribe | boolean |
Custom_fields | array |
Complimentary_gift_id | text |
Output fields
| Field | Type |
|---|---|
Subscription Update ID | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Subscription_idsRequired | array |
Subscription_id | text |
New_statusRequired | text |
Input fields
| Field | Type |
|---|---|
PublicationRequired | choice |
Subscription_idsRequired | array |
Subscription_id | text |
New_statusRequired | text |