Buttondown logo

IntroductionStatusesCadencesBehaviorsItem Statuses

Routes

Listing external feedsCreating an external feedUpdating an external feedDeleting an external feedRetrieving an external feedListing external feed itemsCreating an external feed item

Buttondown logo

Introduction

An automation is a one-to-one mapping between an external RSS feed and an action to be performed when new items are detected in that feed. Right now, Buttondown offers two actions:

  • Send an email
  • Create an email but save it as a draft to be sent out manually

The automation is configured with a cadence, which is the frequency at which the automation will be run. The cadence can be one of the following:

  • Run the automation every time a new item is detected in the feed
  • Run the automation once per week
  • Run the automation once per month
{
    "id": "rss_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "last_checked_date": null,
    "status": "active",
    "behavior": "draft",
    "cadence": "daily",
    "cadence_metadata": {},
    "filters": {
        "filters": [],
        "groups": [],
        "predicate": "and"
    },
    "url": "https://example.com/feed",
    "subject": "New post: {{ item.title }}",
    "body": "I just published a new post: {{ item.url }}",
    "label": "Basic external feed",
    "metadata": {},
    "skip_old_items": true
}

Fields

id

Type
string
Description

A unique TypeID associated with the object.

creation_date

Type
string
Description

The date and time at which the object was first created.

last_checked_date

Type
string
Description

The most recent date and time this feed was checked for new items.

status

Type
ExternalFeedAutomationStatus
Description

The current status of the external feed automation.

behavior

Type
ExternalFeedAutomationBehavior
Description

Whether feed items are sent immediately or drafted for manual review.

cadence

Type
ExternalFeedAutomationCadence
Description

How frequently this feed should create or draft emails.

cadence_metadata

Type
object
Description

Additional scheduling details for the selected cadence, such as weekday or time.

filters

Type
FilterGroup
Description

Tag-based filtering rules used to decide which subscribers receive feed-generated emails.

url

Type
string
Description

The URL of the RSS feed to poll for new items.

subject

Type
string
Description

The subject line template for emails generated from this feed.

body

Type
string
Description

The body template for emails generated from this feed.

label

Type
string
Description

An optional internal label for this feed.

metadata

Type
object
Description

Metadata to be passed to emails rendered by this RSS feed.

skip_old_items

Type
boolean
Description

Skip items with publish date older than one day from when they're discovered