xmlns:cerkl documentation

In any RSS or Atom feeds, Cerkl treats all items or entries as Updates with normal priority. Cerkl namespace enables users to specify the contents' priority and also its type such as Needs or Events.

Items in a feed will not be pulled in if:

Examples: RSS | Atom

Priority

<cerkl:priority>1</cerkl:priority>

Tag Description
cerkl:priority Optional. 0 for normal. 1 for top priority. Default: 0

Need

<cerkl:need>

<cerkl:quantity>1</cerkl:quantity>

<cerkl:date_needed>20 Aug 2016</cerkl:date_needed>

</cerkl:need>
Tag Description
cerkl:quantity required. The quantity needed.
cerkl:date_needed required. The goal date to receive the requested quantity by.

Event

<cerkl:event>

<cerkl:date_start>Wed, 20 Aug 2016 12:50:30 +0000</cerkl:date_start>

<cerkl:all_day>false</cerkl:all_day>

<cerkl:date_end>Wed, 20 Aug 2016 12:51:30 +0000</cerkl:date_end>

<cerkl:location>Innovation Center</cerkl:location>

</cerkl:event>
Tag Description
cerkl:date_start required. The DateTime of when the event is starting. Default timezone is -0500 (EST)
cerkl:all_day True or False. If False, cerkl:date_end is required
cerkl:date_end The DateTime of when the event is ending.
cerkl:location optional. Location when the event is taken place.

RSS Example

<?xml version="1.0" encoding="UTF-8" ?>

<rss version="2.0" xmlns:cerkl="https://app.cerkl.com/cerkl-ns/1.0/">

<channel>

<title>Super Awesome</title>

<link>http://www.super.awe.some</link>

<description>Super Awesomeness</description>

<lastBuildDate>Thu, 18 Aug 2016 10:30:00 -0500</lastBuildDate>

<item>

<title>Super Awesome Jobs</title>

<link>http://examp.le/need</link>

<description>We are looking for highly motivated, highly dedicated candidates to take up the Super Awesome positions!</description>

<pubDate>Thu, 18 Aug 2016 10:30:00 -0500</pubDate>

<cerkl:priority>1</cerkl:priority>

<cerkl:need>

<cerkl:quantity>3</cerkl:quantity>

<cerkl:date_needed>01 Sep 2016</cerkl:date_needed>

</cerkl:need>

</item>

<item>

<title>Team Lunch</title>

<link>http://examp.le/event</link>

<description>Super Awesome Team Lunch is happening this Wednesday!</description>

<pubDate>Mon, 15 Aug 2016 10:00:00 -0500</pubDate>

<cerkl:priority>1</cerkl:priority>

<cerkl:event>

<cerkl:date_start>Wed, 17 Aug 2016 12:30:00 -0500</cerkl:date_start>

<cerkl:all_day>false</cerkl:all_day>

<cerkl:date_end>Wed, 17 Aug 2016 14:00:00 -0500</cerkl:date_end>

<cerkl:location>Super Awesome Restaurant</cerkl:location>

</cerkl:event>

</item>

</channel>

</rss>

Atom Example

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:cerkl="https://app.cerkl.com/cerkl-ns/1.0/">

<title>Super Awesome</title>

<link type="application/atom+xml" rel="self" href="http://www.super.awe.some" />

<updated>Thu, 18 Aug 2016 10:30:00 -0500</updated>

<author>

<name>Super Awesome</name>

<uri>http://www.super.awe.some</uri>

</author>

<id>http://www.super.awe.some</id>

<icon>https://app.cerkl.com/profiles/orgs/</icon>

<generator uri="https://cerkl.com" version="1.0">

Cerkl: Personalization. Automated.

</generator>

<entry>

<author>

<name>SA</name>

</author>

<title>Super Awesome Jobs</title>

<id>http://examp.le/need</id>

<link type="text/html" rel="alternate" href="http://examp.le/need"/>

<content><![CDATA[ We are looking for highly motivated, highly dedicated candidates to take up the Super Awesome positions! ]]></content>

<updated>Thu, 18 Aug 2016 10:30:00 -0500</updated>

<cerkl:priority>1</cerkl:priority>

<cerkl:need>

<cerkl:quantity>3</cerkl:quantity>

<cerkl:date_needed>01 Sep 2016</cerkl:date_needed>

</cerkl:need>

</entry>

<entry>

<author>

<name>SA</name>

</author>

<title>Team Lunch</title>

<id>http://examp.le/event</id>

<link type="text/html" rel="alternate" href="http://examp.le/event"/>

<content><![CDATA[ Super Awesome Team Lunch is happening this Wednesday! ]]></content>

<updated>Mon, 15 Aug 2016 10:00:00 -0500</updated>

<cerkl:priority>1</cerkl:priority>

<cerkl:event>

<cerkl:date_start>Wed, 17 Aug 2016 12:30:00 -0500</cerkl:date_start>

<cerkl:all_day>false</cerkl:all_day>

<cerkl:date_end>Wed, 17 Aug 2016 14:00:00 -0500</cerkl:date_end>

<cerkl:location>Super Awesome Restaurant</cerkl:location>

</cerkl:event>

</entry>

</feed>