Hipchat

by jmccann

The example Yaml configurations in this file are using the legacy 0.8 syntax. If you are using Drone 1.0 or Drone Cloud please ensure you use the appropriate 1.0 syntax. Learn more here.

The Hipchat plugin sends build status messages to users and rooms. The below pipeline configuration demonstrates simple usage:

pipeline:
  hipchat:
    image: jmccann/drone-hipchat
    room: my-room
    auth_token: my-auth-token

Example configuration with a custom hipchat server:

pipeline:
  hipchat:
    image: jmccann/drone-hipchat
    room: my-room
+   url: https://api.hipchat.foo.com

Example configuration with a custom message template:

pipeline:
  hipchat:
    image: jmccann/drone-hipchat
    room: my-room
+   template: |
+     {{ #success build.status }}
+       build {{ build.number }} succeeded. Good job.
+     {{ else }}
+       build {{ build.number }} failed. Fix me please.
+     {{ /success }}

Parameter Reference

url
HipChat server URL, defaults to https://api.hipchat.com
auth_token
HipChat V2 API token; use a room or user token with the Send Notification scope
room
ID or URL encoded name of the room
from: drone
A label to be shown in addition to sender’s name
notify: false
Whether this message should trigger a user notification. See https://www.hipchat.com/docs/apiv2/method/private_message_user

Is there a mistake on this page? Please let us know or edit this page.