Buttondown Documentation

Buttondown Documentation

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook

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": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
    "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

creation_date

Type
string
Description

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

last_checked_date

Type
string

status

Type
ExternalFeedAutomationStatus

behavior

Type
ExternalFeedAutomationBehavior

cadence

Type
ExternalFeedAutomationCadence

cadence_metadata

Type
object

filters

Type
FilterGroup

url

Type
string

subject

Type
string

body

Type
string

label

Type
string

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

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook