im.kayac.com

Welcome to Notification HUB API


    Source                                                  Destination
    -------------------------------------------------------------------



    HTTP POST      .--------------.       XMPP               .--------.
    ------------>  |              |     .------------------> | Jabber |
                   |              |     |                    '--------'
                   | im.kayac.com |-----+
    EMail          |              |     |                    .--------.
    ------------>  |              |     '------------------> | iPhone |
                   '--------------'       Apple Push         '--------'
                                            Notification (APNs)

im.kayac.com is a web service that provides some notification APIs.

You can easily send notify to your jabber or iphone by HTTP API or Email forwarding

Currently supports as notification sources:

HTTP POST
Email

Notification targets:

Jabber, Google Talk
iPhone

Usage:

HTTP POST:

POST /api/post/username HTTP/1.0
Host: im.kayac.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 22

message=Hello%20World!

or more easily way with curl (same as above)

curl -d 'message=Hello World' http://im.kayac.com/api/post/username

See documentation for more detail.

Signup now!

API Documentation

Request

URL

Message should be POSTed to following URL:

http://im.kayac.com/api/post/{username}

Method

POST

POST Parameters

message (required)
a text message sending to {username} (this value should be valid utf-8)
handler (optional)
custom url scheme for iPhone application. (ex: mailto:example@example.com or tweetie://)
If this value is set and can be opened by iPhone, then you can open the url directly from im.kayac.com iPhone application
For more information about custom url scheme, check this site.
password (optional)
If {username} use password authentication, valid password is required.
sig (optional)
If {username} use secret authentication, valid secret signature is required.

Secret segnature is SHA-1 hex digest of {message}+{secretkey}. For example, message is "Hello" and secret key is "SecretKey":

sig=3e287020daaa2771e73ceda2e798c2d576882f22  // sha1_hex( "HelloSecretKey" );

Response

Response is a JSON format like below:

{
  "id": null,
  "error", "",
  "result", "posted"
}

Response parameters

error
Error message string if error is occured.
result
Response message. If request success, "posted" is returned.

Third-party applications

irssi script
tiarra script
ruby module
PHP example
HookHub supports notification via im.kayac.com