pushover

Send notifications via Pushover during state runs.

Important

See Configuration for a description of available configuration parameters.

Example

pushover-message:
  pushover.post_message:
    - user: uQiRzpo4DXghDmr9QzzfQu27cmVRsG
    - token: azGDORePK8gMaC0QOYAMyEEuzJnyUi
    - title: Message from Salt
    - device: phone
    - priority: -1
    - expire: 3600
    - retry: 5
    - message: 'This state was executed successfully.'
saltext.pushover.states.pushover.post_message(name, message, title=None, user=None, device=None, priority=0, expire=None, retry=None, sound=None, token=None)[source]

Send a message to a Pushover user or group.

pushover-message:
  pushover.post_message:
    - user: uQiRzpo4DXghDmr9QzzfQu27cmVRsG
    - token: azGDORePK8gMaC0QOYAMyEEuzJnyUi
    - title: Message from Salt
    - device: phone
    - priority: -1
    - expire: 3600
    - retry: 5
    - message: 'This state was executed successfully.'
name

The name of the state. Irrelevant.

message

Message text to send. Required.

title

Message title. Defaults to Message from Salt.

user

User or group of users to send the message to. Must be a user/group ID (key), not a name or an email address. Required if not specified in the configuration.

device

Name of the device to send the message to. Defaults to all devices of the user.

priority

Message priority (integers between -2 and 2). Defaults to 0.

Note

Emergency priority (2) requires expire and retry parameters to be set.

expire

Stop notifying the user after the specified amount of seconds. The message is still shown after expiry.

retry

Repeat the notification after this amount of seconds. Minimum: 30.

sound

Notification sound to play. Defaults to user default.

token

Pushover API key. Required if not specified in the configuration.