...
You can append query options to the URI in the following format, ?options=value&option2=value&...
URI Options
Name | Default Value | Context | Required | Producer/Consumer | Description |
|---|
authToken | null
| Shared | Yes | Both | Authorization token(personal access token) obtained from Hipchat |
protocol | http
| Shared | No | Both | Default protocol to connect to the Hipchat server |
consumeUsers | null
| Shared | No | Consumer | Comma separated list of user @Mentions or emails whose messages to the owner of authToken must be consumed |
| host | api.hipchat.com | Shared | No | Both | The API host of the Hipchat to connect to |
| port | 80 | Shared | No | Both | The port to connect to on the Hipchat host |
| delay | 5000 | Shared | No | Consumer | The poll interval in millisec for consuming messages from consumeUsers provided. Please read about rate limits before increasing this. |
...
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Header | Constant | Type | Description |
|---|
| HipchatFromUser | HipchatConstants.FROM_USER | String | The body has the message that was sent from this user to the owner of authToken | | HipchatMessageDate | HipchatConstants.MESSAGE_DATE | String | The date message was sent. The format is ISO-8601 as present in the Hipchat response. | | HipchatFromUserResponseStatus | HipchatConstants.FROM_USER_RESPONSE_STATUS | StatusLine | The status of the API response received. |
|
...
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Header | Constant | Type | Description |
|---|
| HipchatToUser | HipchatConstants.TO_USER | String | The Hipchat user to which the message needs to be sent. | | HipchatToRoom | HipchatConstants.TO_ROOM | String | The Hipchat room to which the message needs to be sent. | | HipchatMessageFormat | HipchatConstants.MESSAGE_FORMAT | String | Valid formats are 'text' or 'html'. Default: 'text' | | HipchatMessageBackgroundColor | HipchatConstants.MESSAGE_BACKGROUND_COLOR | String | Valid color values are 'yellow', 'green', 'red', 'purple', 'gray', 'random'. Default: 'yellow' (Room Only) | | HipchatTriggerNotification | HipchatConstants.TRIGGER_NOTIFY | String | Valid values are 'true' or 'false'. Whether this message should trigger a user notification (change the tab color, play a sound, notify mobile phones, etc). Default: 'false' (Room Only) |
|
...
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Header | Constant | Type | Description |
|---|
| HipchatToUserResponseStatus | HipchatConstants.TO_USER_RESPONSE_STATUS | StatusLine | The status of the API response received when message sent to the user. | | HipchatFromUserResponseStatus | HipchatConstants.TO_ROOM_RESPONSE_STATUS | StatusLine | The status of the API response received when message sent to the room. |
|
...
