< Back
Send-ProwlNotification
Post
NAME Send-ProwlNotification
SYNOPSIS
Send a Prowl notification.
SYNTAX
Send-ProwlNotification [-ApiKeys] <String[]> [[-Subject] <String>] [[-Message] <String>] [[-From] <String>]
[[-ProviderKey] <String>] [[-Priority] <Int32>] [[-Url] <String>] [<CommonParameters>]
DESCRIPTION
Send a Prowl push notification to one or more API keys.
PARAMETERS
-ApiKeys <String[]>
One or more Prowl API keys to send to.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Subject <String>
The name of the event or subject of the notification. Required if Message is not specified. (1024 bytes max)
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
A description of the event, generally terse. Required if Subject is not specified. (10,000 bytes max)
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-From <String>
The name of your application or the sender of the event. (256 bytes max)
Required? false
Position? 4
Default value Posh-Prowl
Accept pipeline input? false
Accept wildcard characters? false
-ProviderKey <String>
Your provider API key. Only necessary if you have been whitelisted.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Int32>
The priority of the notification ranging from -2 to 2 where -2 is Very Low and 2 is Emergency. Emergency
priority messages may bypass quiet hours according to the user's settings.
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Url <String>
The URL which should be attached to the notification. This will trigger a redirect when launched, and is
viewable in the notification list. (512 bytes max)
Required? false
Position? 7
Default value
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-ProwlNotification 'XXXXXXXXXXXX' -Subject 'The operation is complete.'
Send a subject-only message to a single API key.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$keys = 'XXXXXXXXXXXXXXXX','YYYYYYYYYYYYYYYY'
PS C:\\>$from = 'The Ticketing System'
PS C:\\>$subject = 'Ticket Requires Attention'
PS C:\\>$msg = 'Ticket #12345 requires authorization.'
PS C:\\>$url = 'https://example.com/tickets/12345'
PS C:\\>$keys | Send-ProwlNotification -Subject $subject -Message $msg -From $from -Url $url
Send a message to multiple recipients with a custom app name and URL link
RELATED LINKS
Project: https://github.com/rmbolger/Posh-Prowl
SYNOPSIS
Send a Prowl notification.
SYNTAX
Send-ProwlNotification [-ApiKeys] <String[]> [[-Subject] <String>] [[-Message] <String>] [[-From] <String>]
[[-ProviderKey] <String>] [[-Priority] <Int32>] [[-Url] <String>] [<CommonParameters>]
DESCRIPTION
Send a Prowl push notification to one or more API keys.
PARAMETERS
-ApiKeys <String[]>
One or more Prowl API keys to send to.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Subject <String>
The name of the event or subject of the notification. Required if Message is not specified. (1024 bytes max)
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
A description of the event, generally terse. Required if Subject is not specified. (10,000 bytes max)
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-From <String>
The name of your application or the sender of the event. (256 bytes max)
Required? false
Position? 4
Default value Posh-Prowl
Accept pipeline input? false
Accept wildcard characters? false
-ProviderKey <String>
Your provider API key. Only necessary if you have been whitelisted.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Int32>
The priority of the notification ranging from -2 to 2 where -2 is Very Low and 2 is Emergency. Emergency
priority messages may bypass quiet hours according to the user's settings.
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Url <String>
The URL which should be attached to the notification. This will trigger a redirect when launched, and is
viewable in the notification list. (512 bytes max)
Required? false
Position? 7
Default value
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-ProwlNotification 'XXXXXXXXXXXX' -Subject 'The operation is complete.'
Send a subject-only message to a single API key.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$keys = 'XXXXXXXXXXXXXXXX','YYYYYYYYYYYYYYYY'
PS C:\\>$from = 'The Ticketing System'
PS C:\\>$subject = 'Ticket Requires Attention'
PS C:\\>$msg = 'Ticket #12345 requires authorization.'
PS C:\\>$url = 'https://example.com/tickets/12345'
PS C:\\>$keys | Send-ProwlNotification -Subject $subject -Message $msg -From $from -Url $url
Send a message to multiple recipients with a custom app name and URL link
RELATED LINKS
Project: https://github.com/rmbolger/Posh-Prowl