Send a error/success message to HipChat

Send a message to room (by default) or a direct message to @username with success (green) or failure (red) status.

Supported platforms ios, android, mac
Author @jingx23

1 Example

  message: "App successfully released!",
  message_format: "html", # or "text", defaults to "html"
  channel: "Room or @username",
  success: true


Key Description Default
message The message to post on HipChat ''
channel The room or @username
api_token Hipchat API Token
custom_color Specify a custom color, this overrides the success boolean. Can be one of 'yellow', 'red', 'green', 'purple', 'gray', or 'random'
success Was this build successful? (true/false) true
version Version of the Hipchat API. Must be 1 or 2
notify_room Should the people in the room be notified? (true/false) false
api_host The host of the HipChat-Server API api.hipchat.com
message_format Format of the message to post. Must be either 'html' or 'text' html
include_html_header Should html formatted messages include a preformatted header? (true/false) true
from Name the message will appear to be sent from fastlane

* = default value is dependent on the user's system


To show the documentation in your terminal, run

fastlane action hipchat


It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run hipchat

To pass parameters, make use of the : symbol, for example

fastlane run hipchat parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions