Buttondown logo

Creating an external feed

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/external_feeds"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "url": "http://lorem-rss.herokuapp.com/feed",
  "metadata": {
    "foo": "bar"
  }
}

response = requests.request("POST", url, headers=headers, json=data)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "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
}

Body parameters

All parameters are optional unless explicitly specified.

url

Type
string · required
Description

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

Example
"http://lorem-rss.herokuapp.com/feed"

behavior

Type
ExternalFeedAutomationBehavior
Description

The behavior of the external feed.

Example
"draft"

cadence

Type
ExternalFeedAutomationCadence
Description

How frequently this feed should create or draft emails.

Example
"daily"

cadence_metadata

Type
object · required
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.

subject

Type
string · required
Description

The subject line template for emails generated from this feed.

body

Type
string · required
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.

Example
{ "foo": "bar" }

skip_old_items

Type
boolean
Description

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