POST
/
projects
/
{project_id}
/
integrations
/
rss_importer
/
feeds
/
test
curl --request POST \
  --url https://api.beyondwords.io/v1/projects/{project_id}/integrations/rss_importer/feeds/test \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "enabled": true,
  "feed_url": "<string>",
  "feed_content_type": "xml",
  "feed_headers": {},
  "import_interval": 123,
  "extractor_enabled": true,
  "static_ip_enabled": true,
  "extractor_headers": {},
  "map": {
    "title": [
      "<string>"
    ],
    "body": [
      "<string>"
    ],
    "summary": [
      "<string>"
    ],
    "source_id": "<string>",
    "source_url": "<string>",
    "author": "<string>",
    "metadata": "<string>",
    "image_url": "<string>",
    "publish_date": "<string>"
  }
}'
{
  "items": [
    {
      "title": [
        "title"
      ],
      "body": [
        "content"
      ],
      "summary": [
        "description"
      ],
      "source_id": "podcast_id_1",
      "source_url": "https://beyondwords.io/",
      "author": "James",
      "metadata": "meta",
      "image_url": "media",
      "publish_date": "2020-01-09 22:18:26 UTC",
      "raw_item": {
        "title": "title",
        "description": "description",
        "guid": "podcast_id_1",
        "pubDate": "2050-01-01 00:00:00 UTC",
        "link": "https://beyondwords.io/"
      }
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Body

application/json
​
feed_url
string
required

URL of the RSS feed you want to import.

​
feed_content_type
enum<string>
required

Type of content in the feed. Possible values include xml or json.

Available options:
xml,
json
​
enabled
boolean

Whether importing is enabled or disabled.

​
feed_headers
object

Headers that you want to include in the HTTP request when fetching the RSS feed.

​
import_interval
integer

Number of minutes between each import of the RSS feed.

​
extractor_enabled
boolean

Whether or not the RSS importer should fetch the content from the page linked in the map.source_url property. Set to true if the RSS feed does not contain the content. In this case you can set map.body to null.

​
static_ip_enabled
boolean

Enable to add a dedicated IP address to an allowlist.

​
extractor_headers
object

Headers that you want to include in the HTTP request when fetching and extracting the content from the map.source_url.

​
map
object

Object that contains mappings between the data in the RSS feed and the properties in the content object. Each property in the map object represents a property in the content object, and its value is a string that represents the name of the corresponding element in the RSS feed.

Response

200 - application/json
successful
​
items
object[]
Previous
List pronunciation rules
Next