Skip to content

wichon/hubot-json-rest

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Hubot Rest Json Adapter

An adapter for Hubot to work via HTTP using Json as data format.

Useful for web chat interfaces.

Setup

Set HUBOT_REST_SEND_URL as an environment variable to send hubot responses to.

Hubot response is sent in json format, with the following structure:

{
  from: 'botname',
  message: 'message body string'
}

Special Options Hash

Typically messages to Hubot have three parameters: Message, User and Room. This adapter allows for an extendable options has to be sent with the message.

To send options, when posting to Hubot use the following hash:

// post: /receive/:room
{
  from: 'nickname string',
  message: 'message body string',
  options: {
    "javascript": "object"
  }
}

The options hash can be accessed in a script with msg.message.user.options.

About

Hubot adapter using HTTP and Json as data format

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CoffeeScript 100.0%