< Back
Send-HipChatMessage
Post
NAME Send-HipChatMessage
SYNOPSIS
Sends a message to a room in HipChat.
SYNTAX
Send-HipChatMessage [-AuthToken] <String> [-RoomID] <String> [-Message] <String> [[-Color] <String>] [[-Notify]
<String>] [[-MessageFormat] <String>] [[-ApiHost] <String>] [[-TimeoutSecs] <String>] [<CommonParameters>]
DESCRIPTION
Sends a message to a room in HipChat.
PARAMETERS
-AuthToken <String>
Required. Your HipChat API token, created here https://www.hipchat.com/account/api
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RoomID <String>
Required. The id of the room.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
Required. The message body. 10,000 characters max.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color <String>
The background color of the HipChat message. One of "yellow", "red", "green", "purple", "gray", or "random".
Defaults to gray.
Required? false
Position? 4
Default value gray
Accept pipeline input? false
Accept wildcard characters? false
-Notify <String>
Whether this message should trigger a user notification (change the tab color, play a sound, notify mobile
phones, etc).
Each recipient's notification preferences are taken into account. Defaults to false.
Required? false
Position? 5
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-MessageFormat <String>
Determines how the message is treated by the HipChat server and rendered inside HipChat applications. More
info at https://www.hipchat.com/docs/apiv2/meth ... tification.
Valid values are html or text, defaults to 'text'.
Required? false
Position? 6
Default value text
Accept pipeline input? false
Accept wildcard characters? false
-ApiHost <String>
The URI of the HipChat api (default: api.hipchat.com).
Required? false
Position? 7
Default value api.hipchat.com
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSecs <String>
Timeout of the HTTP call to the Hipchat API. Defaults to 10 seconds.
Required? false
Position? 8
Default value 10
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Send-HipChatMessage -AuthToken 1234abcd5678efgh -RoomID 1234 -Message "All your base are belong to us."
RELATED LINKS
https://github.com/DaveStephens/PSHipchat
SYNOPSIS
Sends a message to a room in HipChat.
SYNTAX
Send-HipChatMessage [-AuthToken] <String> [-RoomID] <String> [-Message] <String> [[-Color] <String>] [[-Notify]
<String>] [[-MessageFormat] <String>] [[-ApiHost] <String>] [[-TimeoutSecs] <String>] [<CommonParameters>]
DESCRIPTION
Sends a message to a room in HipChat.
PARAMETERS
-AuthToken <String>
Required. Your HipChat API token, created here https://www.hipchat.com/account/api
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RoomID <String>
Required. The id of the room.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
Required. The message body. 10,000 characters max.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color <String>
The background color of the HipChat message. One of "yellow", "red", "green", "purple", "gray", or "random".
Defaults to gray.
Required? false
Position? 4
Default value gray
Accept pipeline input? false
Accept wildcard characters? false
-Notify <String>
Whether this message should trigger a user notification (change the tab color, play a sound, notify mobile
phones, etc).
Each recipient's notification preferences are taken into account. Defaults to false.
Required? false
Position? 5
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-MessageFormat <String>
Determines how the message is treated by the HipChat server and rendered inside HipChat applications. More
info at https://www.hipchat.com/docs/apiv2/meth ... tification.
Valid values are html or text, defaults to 'text'.
Required? false
Position? 6
Default value text
Accept pipeline input? false
Accept wildcard characters? false
-ApiHost <String>
The URI of the HipChat api (default: api.hipchat.com).
Required? false
Position? 7
Default value api.hipchat.com
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSecs <String>
Timeout of the HTTP call to the Hipchat API. Defaults to 10 seconds.
Required? false
Position? 8
Default value 10
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Send-HipChatMessage -AuthToken 1234abcd5678efgh -RoomID 1234 -Message "All your base are belong to us."
RELATED LINKS
https://github.com/DaveStephens/PSHipchat