hipchat_send: Send a message to the hipchat API v2.

In robertzk/hipchat: An R package for communicating with the hipchat API

Description

Send a message to the hipchat API v2.

Usage

hipchat_send(type, var, ..., api_token = hipchat_api_token(),
  method = "GET")

Arguments

type	character. One of the native Hipchat API domains: c('addon', 'capabilities', 'emoticon', 'oauth', 'room' 'user').
var	character. Whatever goes after the type in the hipchat API url, typically room ID, or user email, depending on the API path you are calling.
...	HTTP arguments to send to the Hipchat API. Unnamed arguments will be passed in to the URL; named arguments will be assumed to be API parameters. See the examples section.
api_token	character. By default, hipchat_api_token().
method	character. HTTP method. Either "GET", "POST", "PUT", or "DELETE". By default, the API url will be inspected and matched with the appropriate method. Otherwise, "GET" will be used.

Value

the JSON output response from the Hipchat API.

References

https://www.hipchat.com/docs/apiv2

Examples

## Not run: 
  hipchat_send('room', 'My room', 'notification',
    color = 'green', message = 'Everything looks <b>green</b>',
    notify = FALSE, message_format = 'html')
  # posts to https://api.hipchat.com/v2/room/My room/notification

  hipchat_send('room', 'My room', 'share', 'link',
     message = 'This looks like a cool package',
     link = 'http://github.com/robertzk/hipchat')
  # posts to https://api.hipchat.com/v2/room/My room/share/link
  # and shares a link with the room.

  hipchat_send('user', '[e-mail]', 'message')
     message = "Hey buddy what's going on?", notify = TRUE,
     message_format = 'text')
  # posts to https://api.hipchat.com/v2/user/[e-mail]/message

  hipchat_send('room', 'My room', 'invite', '[e-mail]',
     reason = "Come join this room mang")
  # posts to https://api.hipchat.com/v2/room/My room/invite/[e-mail]

## End(Not run)

robertzk/hipchat documentation built on May 27, 2019, 10:34 a.m.