POST
/
projects
/
{project_id}
/
integrations
/
rss_importer
/
feeds
curl --request POST \
  --url https://api.beyondwords.io/v1/projects/{project_id}/integrations/rss_importer/feeds \
  --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>"
  }
}'
{
  "id": 1,
  "enabled": true,
  "feed_url": "https://beyondwords.io/rss.xml",
  "feed_content_type": "xml",
  "feed_headers": {
    "Authorization": "Bearer token"
  },
  "import_interval": 10,
  "extractor_enabled": true,
  "static_ip_enabled": false,
  "extractor_headers": {
    "Authorization": "Bearer token"
  },
  "map": {
    "title": [
      "title"
    ],
    "body": [
      "content"
    ],
    "summary": [
      "description"
    ],
    "source_id": "guid",
    "source_url": "link",
    "author": "author",
    "metadata": "meta",
    "image_url": "media",
    "publish_date": "pubDate"
  },
  "last_import": "2020-01-09 22:18:26 UTC",
  "created": "2019-12-09 22:18:26 UTC",
  "updated": "2020-01-23 08:55:38 UTC"
}

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

201 - application/json
successful
​
id
integer
​
enabled
boolean

Whether importing is enabled or disabled.

​
feed_url
string

URL of the RSS feed you want to import.

​
feed_content_type
enum<string>

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

Available options:
xml,
json
​
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.

​
last_import
string | null

Time at which the object was created (ISO 8601)

​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)

Previous
Update RSS feed import
Next