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",
    "error": null,
    "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.

urlstring · required

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

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

behaviorstring · enum · required

The behavior of the external feed.

example
"draft"
values
  • draft

    Create a draft email.

  • emails

    Send emails to subscribers.

cadencestring · enum · required

How frequently this feed should create or draft emails.

example
"daily"
values
  • every

    Act every single time a new item is added to the RSS feed.

  • daily

    Act every day, compiling a digest of new items.

  • weekly

    Act every week, compiling a digest of new items.

  • monthly

    Act every month, compiling a digest of new items.

cadence_metadataCadenceMetadata

Additional scheduling details for the selected cadence. time is required for daily/weekly/monthly cadences; weekday is required for weekly; monthday is required for monthly. See the cadence metadata reference for allowed values.

filtersFilterGroup · required

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

subjectstring · required

The subject line template for emails generated from this feed.

bodystring · required

The body template for emails generated from this feed.

labelstring

An optional internal label for this feed.

metadataobject

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

example
{ "foo": "bar" }

skip_old_itemsboolean

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