< Back
Send-HCRoomMessage
Post
NAME Send-HCRoomMessage
SYNOPSIS
Sends a message to a HipChat room using version 2 api
SYNTAX
Send-HCRoomMessage [-Hostname] <String> [-AuthToken] <String> [-RoomID] <Int32> [[-Message] <String>] [[-From]
<String>] [[-Colour] <String>] [[-Format] <String>] [-DisableCertCheck] [-NoSSL] [<CommonParameters>]
DESCRIPTION
See synopsis.
PARAMETERS
-Hostname <String>
The name of host to connect to, this can be either an IP address or hostname
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthToken <String>
You can get this by going to https://hipchatserver.blah/rooms/tokens/9999
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RoomID <Int32>
The room ID number, look in the url to find this number when in chat
Required? true
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
The message in either HTML or plain text to send
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-From <String>
An additional name to add to the from tag, note the API token name is always used regardless
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Colour <String>
The message colour the default is yellow
Required? false
Position? 6
Default value yellow
Accept pipeline input? false
Accept wildcard characters? false
-Format <String>
The available formats are HTML or text
Required? false
Position? 7
Default value text
Accept pipeline input? false
Accept wildcard characters? false
-DisableCertCheck [<SwitchParameter>]
Disables checking the certificate when connecting over https
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoSSL [<SwitchParameter>]
Forces the use of HTTP instead of HTTPS
Required? false
Position? named
Default value False
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-HCRoomMessage -Message 'Hello world!' -RoomID 9999 -AuthToken 000000008c036ce74151407cad43256a6386b99b
-Hostname api.hipchat.com
-------------------------- EXAMPLE 2 --------------------------
Send-HCRoomMessage -Message '<p>Hello world!</p>' -RoomID 9999 -AuthToken 000000008c036ce74151407cad43256a6386b99b
-MessageFormat HTML -Hostname api.hipchat.com
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Send-HCRoomMessage -Message 'Hello world!' -RoomID 9999 -AuthToken 000000008c036ce74151407cad43256a6386b99b
-Colour green -Hostname api.hipchat.com
RELATED LINKS
SYNOPSIS
Sends a message to a HipChat room using version 2 api
SYNTAX
Send-HCRoomMessage [-Hostname] <String> [-AuthToken] <String> [-RoomID] <Int32> [[-Message] <String>] [[-From]
<String>] [[-Colour] <String>] [[-Format] <String>] [-DisableCertCheck] [-NoSSL] [<CommonParameters>]
DESCRIPTION
See synopsis.
PARAMETERS
-Hostname <String>
The name of host to connect to, this can be either an IP address or hostname
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthToken <String>
You can get this by going to https://hipchatserver.blah/rooms/tokens/9999
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RoomID <Int32>
The room ID number, look in the url to find this number when in chat
Required? true
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
The message in either HTML or plain text to send
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-From <String>
An additional name to add to the from tag, note the API token name is always used regardless
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Colour <String>
The message colour the default is yellow
Required? false
Position? 6
Default value yellow
Accept pipeline input? false
Accept wildcard characters? false
-Format <String>
The available formats are HTML or text
Required? false
Position? 7
Default value text
Accept pipeline input? false
Accept wildcard characters? false
-DisableCertCheck [<SwitchParameter>]
Disables checking the certificate when connecting over https
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoSSL [<SwitchParameter>]
Forces the use of HTTP instead of HTTPS
Required? false
Position? named
Default value False
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-HCRoomMessage -Message 'Hello world!' -RoomID 9999 -AuthToken 000000008c036ce74151407cad43256a6386b99b
-Hostname api.hipchat.com
-------------------------- EXAMPLE 2 --------------------------
Send-HCRoomMessage -Message '<p>Hello world!</p>' -RoomID 9999 -AuthToken 000000008c036ce74151407cad43256a6386b99b
-MessageFormat HTML -Hostname api.hipchat.com
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Send-HCRoomMessage -Message 'Hello world!' -RoomID 9999 -AuthToken 000000008c036ce74151407cad43256a6386b99b
-Colour green -Hostname api.hipchat.com
RELATED LINKS