Hipchat
Hipchat notification settings
This node uses the key rooms
as a default prefix if not given a map.
Types
- Sequence of Map
- Sequence of Sequence of Secure
- Sequence of Secure
- Sequence of Boolean
- Map
- Secure
- Boolean
Keys
If given a map, the following keys are supported:
rooms
— Hipchat rooms to notify (needs to include the API token) (type: sequence of secure, or secure)format
— Format to use for the notication (type: enum (string), known values:html
,text
)notify
— Whether to trigger a user notification (using v2) (type: boolean)on_pull_requests
— Whether to notify on pull requests (type: boolean)template
— Templates to use for the notification message (type: sequence of string, or string)if
— Condition to determine if a build, stage, or job should be run, a config source imported, or a notification sent (type: string, e.g.:branch = master
, see: Conditional Builds, Stages, and Jobs, Conditional Notifications)on_success
— Notification frequency (type: enum (string), known values:always
,never
,change
)on_failure
— Notification frequency (type: enum (string), known values:always
,never
,change
)enabled
— Whether to enable these notifications (type: boolean)disabled
— Whether to disable these notifications (type: boolean)
Examples
hipchat:
- rooms:
- secure: encrypted string
format: html
notify: true
- rooms:
secure: encrypted string
hipchat:
- secure: encrypted string
hipchat:
- true
hipchat:
rooms:
- secure: encrypted string
format: html
notify: true
hipchat:
secure: encrypted string
hipchat: true