The rssCloud protocol spoken as plain application/x-www-form-urlencoded
HTTP POSTs. Subscribers register a callback with POST /pleaseNotify;
publishers announce a change with POST /ping. The same notifications
can also be driven over XML-RPC, and a single ping reaches
subscribers of every protocol — see How it fits together.
Tell the server you want to be notified when one or more resources (feeds) change.
The form parameters are:
| Parameter | Required | Meaning |
|---|---|---|
protocol |
yes | How the server should notify you: http-post, https-post, or xml-rpc. |
port |
yes | Port of your callback. |
path |
yes | Path of your callback. |
url1, url2, … urlN |
yes | The resource URL(s) you want to watch. For a feed, its URL. |
domain |
no | Your callback host. If omitted, the server uses the requesting IP address. |
registerProcedure |
no | Accepted for spec compatibility but ignored (only meaningful for XML-RPC/SOAP). |
https-post is identical to http-post except notifications are sent over HTTPS.
As a convenience, http-post with port 443 is also notified over HTTPS; for any
other HTTPS port, use https-post.
Before recording the subscription, the server confirms your resource URLs return an HTTP 2xx, then proves your callback works — in one of two ways:
domain given (IP-based). The server POSTs to http://<ip>:<port><path>
with a single url parameter. Reply with any 2xx to accept.domain given (challenge). The server GETs
http://<domain>:<port><path>?url=<resource>&challenge=<token>. Reply 2xx and
echo the challenge value verbatim as the body to accept.Two values are returned: success (true/false) and msg (a human-readable
explanation). The default content type is text/xml; send Accept: application/json
for JSON.
<?xml version="1.0"?>
<notifyResult success="false" msg="The subscription was cancelled because the call failed when we tested the handler."/>
{
"success": false,
"msg": "The subscription was cancelled because the call failed when we tested the handler."
}
Tell the server a resource has been updated.
| Parameter | Required | Meaning |
|---|---|---|
url |
yes | The resource URL that changed. |
The server re-fetches the URL and, only if the content actually changed, fans the
notification out to every subscriber of that resource (see
How it fits together). The default content type is text/xml;
send Accept: application/json for JSON.
<?xml version="1.0"?>
<result success="true" msg="Thanks for the ping."/>
{ "success": true, "msg": "Thanks for the ping." }
GET /pleaseNotifyForm — an HTML form for subscribing from a browser.GET /pingForm — an HTML form for pinging from a browser.GET /viewLog — a live log of recent server events, handy when debugging your tools.