Web Services

Our API

We're now offering a public API to software developers, giving you the power to create and manage hosted feeds from within your software programs, web applications and web sites.

And the best news... it's easy as pie! Simply embed an HTML form in a web page, or automate HTTP requests to self-explanatory URLs such as http://ws.mynotify.com/new/feed and http://ws.mynotify.com/new/story.

Our API program is still being fine-tuned and we welcome your feedback. To make a suggestion or to request an authorization key, please contact us at api [at] mynotify.com.

Table of Contents

1. Getting started
2. Creating a new feed
3. Listing your feeds
4. Adding a new story to your feed
5. Listing your stories
6. Delete a story
7. Edit a feed
8. Edit a story

Getting started

Your authorization key

The first thing you need to do is request an authorization key. Please contact us at api [at] mynotify.com if you would like to participate in our public API program.

Your authorization key is private, and you are responsible for any use of this key. Never include your authorization key on a web site which is publicly accessible on the Internet.

Back to top

Creating a new feed

From a web page

To create a new feed from your web site, you will need use the HTML code below. Be sure to replace the wskey value with your authorization key, the mynotify_success value with the URL you would like to redirect to if the feed is created successfully, and the mynotify_error value with the URL you would like to redirect to if the feed can not be created.

The rss_title, rss_link, and rss_description fields are optional. All other fields are mandatory.

The password you set here is never used through the API, but can be used if you need to sign in using our web interface.

<form action="http://ws.mynotify.com/new/feed" method="post"> <input type="hidden" name="mynotify_wskey" value="AUTHORIZATION KEY" /> <input type="hidden" name="mynotify_success" value="SUCCESS URL" /> <input type="hidden" name="mynotify_error" value="ERROR URL" /> URL: http://mynotify.com/<input type="text" maxlength="25" name="id">.rss<br/> Title: <input type="text" name="rss_title"><br/> Link: <input type="text" name="rss_link"><br/> Description: <input type="text" name="rss_description"><br/> Password: <input type="password" name="password"><br/> Email: <input type="text" name="email_address"><br/><br/> <input type="submit"> </form>

From your web-enabled application

To create a new feed from your web-enabled application, you need to send an HTTP POST request to http://ws.mynotify.com/new/feed containing all of the fields in the above form excluding mynotify_success and mynotify_error. Omitting these two fields from your request results in an AJAX-friendly JSON-formatted response to be returned from the API server. Response codes less than 0 indicate failure, and response codes greater than 0 indicate success. [-102, [ "Your feed's URL should only contain letters, numbers, underscores (_) and hyphens (-), and be no longer than 25 characters.", "Your password should only contain letters, numbers, underscores (_) and hyphens (-), and be at least six characters in length.", "You must enter a valid email address" ] ]
Back to top

Listing your feeds

From a web page

Warning: This step is optional, a little bit tricky, and may require the assistance of an experienced programmer.

To list your feeds from your web site, you will need use the HTML code below. After the form is submitted, you will be taken to the mynotify_success URL - but with an HTTP GET parameter added containing a JSON-formatted list of your feeds. Be sure to replace the wskey value with your authorization key, the mynotify_success value with the URL you would like to redirect to, and the mynotify_error value with the URL you would like to redirect to if your list can not be retrieved.

<form action="http://ws.mynotify.com/list/feed" method="post"> <input type="hidden" name="mynotify_wskey" value="AUTHORIZATION KEY" /> <input type="hidden" name="mynotify_success" value="SUCCESS URL" /> <input type="hidden" name="mynotify_error" value="ERROR URL" /> <input type="submit"> </form>

From your web-enabled application

To list your feeds from your web-enabled application, you need to send an HTTP POST request to http://ws.mynotify.com/list/feed containing only the mynotify_wskey field from the above form. This will result in an AJAX-friendly JSON-formatted response being returned from the API server. Response codes less than 0 indicate failure, and response codes greater than 0 indicate success - and include a list of feeds. [400, {"myawesomefeed" : "The feed's title'", "myotherfeed" : "Title of this feed", "somegreatfeed" : "Another feed title", } ]
Back to top

Adding a new story to your feed

From a web page

To add a new story to your feed from your web site, you will need use the HTML code below. Be sure to replace the wskey value with your authorization key, the mynotify_success value with the URL you would like to redirect to if the story is added successfully, and the mynotify_error value with the URL you would like to redirect to if the story can not be added.

You must also append your feed's id to the form's action URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

The link and description fields are optional. All other fields are mandatory.

<form action="http://ws.mynotify.com/new/story/FEED_ID" method="post"> <input type="hidden" name="mynotify_wskey" value="AUTHORIZATION KEY" /> <input type="hidden" name="mynotify_success" value="SUCCESS URL" /> <input type="hidden" name="mynotify_error" value="ERROR KEY" /> Title: <input type="text" name="title"><br/> Link: <input type="text" name="link"><br/> Story text: <input type="text" name="description"><br/> <input type="submit"> </form>

From your web-enabled application

To add a new story from your web-enabled application, you need to send an HTTP POST request to http://ws.mynotify.com/new/story/FEED_ID containing all of the fields in the above form excluding mynotify_success and mynotify_error. Omitting these two fields from your request results in an AJAX-friendly JSON-formatted response to be returned from the API server.

You must also append your feed's id to the URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

Response codes less than 0 indicate failure, and response codes greater than 0 indicate success.

[-200, "Please enter a title" ]
Back to top

Listing your stories

From a web page

Warning: This step is optional, a little bit tricky, and may require the assistance of an experienced programmer.

To list a feed's stories from your web site, you will need use the HTML code below. After the form is submitted, you will be taken to the mynotify_success URL - but with an HTTP GET parameter added containing a JSON-formatted list of your feed's stories. Be sure to replace the wskey value with your authorization key, the mynotify_success value with the URL you would like to redirect to, and the mynotify_error value with the URL you would like to redirect to if your list can not be retrieved.

You must also append your feed's id to the form's action URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

<form action="http://ws.mynotify.com/list/story/FEED_ID" method="post"> <input type="hidden" name="mynotify_wskey" value="AUTHORIZATION KEY" /> <input type="hidden" name="mynotify_success" value="SUCCESS URL" /> <input type="hidden" name="mynotify_error" value="ERROR KEY" /> <input type="submit"> </form>

From your web-enabled application

To list your feed's stories from your web-enabled application, you need to send an HTTP POST request to http://ws.mynotify.com/list/story/FEED_ID containing only the mynotify_wskey field from the above form. This will result in an AJAX-friendly JSON-formatted response being returned from the API server.

You must also append your feed's id to the URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

Response codes less than 0 indicate failure, and response codes greater than 0 indicate success - and include a list of stories. [500, {"113" : "The title of this story", "512" : "The title of another story" } ]
Back to top

Deleting a story from your feed

From a web page

To delete a story from one of your feeds from your web site, you will need use the HTML code below. Be sure to replace the wskey value with your authorization key, the mynotify_success value with the URL you would like to redirect to after your story is deleted, and the mynotify_error value with the URL you would like to redirect to if the story can not be deleted.

You must also append your feed's id to the form's action URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

You must also append a story's id to the form's action URL. This story id is the numerical ID of one of the stories owned by your feed, as found by listing your stories. You must replace STORY_ID with this value.

<form action="http://ws.mynotify.com/delete/story/FEED_ID/STORY_ID" method="post"> <input type="hidden" name="mynotify_wskey" value="AUTHORIZATION KEY" /> <input type="hidden" name="mynotify_success" value="SUCCESS URL" /> <input type="hidden" name="mynotify_error" value="ERROR KEY" /> <input type="submit"> </form>

From your web-enabled application

To delete a story from within your web-enabled application, you need to send an HTTP POST request to http://ws.mynotify.com/delete/story/FEED_ID/STORY_ID containing only the mynotify_wskey field from the above form. This will result in an AJAX-friendly JSON-formatted response being returned from the API server.

You must also append your feed's id to the URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

You must also append a story's id to the URL. This story id is the numerical ID of one of the stories owned by your feed, as found by listing your stories. You must replace STORY_ID with this value.

Response codes less than 0 indicate failure, and response codes greater than 0 indicate success.

[300, "Story deleted." ]
Back to top

Editing your feed

From a web page

To modify one of your feeds from your web site, you will need use the HTML code below. Be sure to replace the wskey value with your authorization key, the mynotify_success value with the URL you would like to redirect to if the feed is modified successfully, and the mynotify_error value with the URL you would like to redirect to if the feed can not be changed.

The rss_title, rss_link, and rss_description fields are optional. All other fields are mandatory.

The password you set here is never used through the API, but can be used if you need to sign in using our web interface.

You must also append your feed's id to the form's action URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

<form action="http://ws.mynotify.com/edit/feed/FEED_ID" method="post"> <input type="hidden" name="mynotify_wskey" value="AUTHORIZATION KEY" /> <input type="hidden" name="mynotify_success" value="SUCCESS URL" /> <input type="hidden" name="mynotify_error" value="ERROR URL" /> URL: http://mynotify.com/<input type="text" maxlength="25" name="id">.rss<br/> Title: <input type="text" name="rss_title"><br/> Link: <input type="text" name="rss_link"><br/> Description: <input type="text" name="rss_description"><br/> Password: <input type="password" name="password"><br/> Email: <input type="text" name="email_address"><br/><br/> <input type="submit"> </form>

From your web-enabled application

To edit feed properties from your web-enabled application, you need to send an HTTP POST request to http://ws.mynotify.com/edit/feed/FEED_ID containing all of the fields in the above form excluding mynotify_success and mynotify_error. Omitting these two fields from your request results in an AJAX-friendly JSON-formatted response to be returned from the API server.

You must also append your feed's id to the URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

Response codes less than 0 indicate failure, and response codes greater than 0 indicate success.

[-100, "Your feed has been modified." ]
Back to top

Editing a story

From a web page

To edit a story from your web site, you will need use the HTML code below. Be sure to replace the wskey value with your authorization key, the mynotify_success value with the URL you would like to redirect to if the story is edited successfully, and the mynotify_error value with the URL you would like to redirect to if the story can not be changed.

You must also append your feed's id to the form's action URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

You must also append a story's id to the form's action URL. This story id is the numerical ID of one of the stories owned by your feed, as found by listing your stories. You must replace STORY_ID with this value.

The link and description fields are optional. All other fields are mandatory.

<form action="http://ws.mynotify.com/edit/story/FEED_ID/STORY_ID" method="post"> <input type="hidden" name="mynotify_wskey" value="AUTHORIZATION KEY" /> <input type="hidden" name="mynotify_success" value="SUCCESS URL" /> <input type="hidden" name="mynotify_error" value="ERROR KEY" /> Title: <input type="text" name="title"><br/> Link: <input type="text" name="link"><br/> Story text: <input type="text" name="description"><br/> <input type="submit"> </form>

From your web-enabled application

To change a story from your web-enabled application, you need to send an HTTP POST request to http://ws.mynotify.com/edit/story/FEED_ID/STORY_ID containing all of the fields in the above form excluding mynotify_success and mynotify_error. Omitting these two fields from your request results in an AJAX-friendly JSON-formatted response to be returned from the API server.

You must also append your feed's id to the URL. This feed id is the same value you entered in the id field when you created your feed. For example, if your feed is http://mynotify.com/frank.rss, you would replace FEED_ID with frank.

You must also append a story's id to URL. This story id is the numerical ID of one of the stories owned by your feed, as found by listing your stories. You must replace STORY_ID with this value.

Response codes less than 0 indicate failure, and response codes greater than 0 indicate success.

[200, "Your story has been modified." ]