pushover

Documentation

Index

• type AlertProvider
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) IsValid() bool
  • func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, ...) error
• type Body

Types

type AlertProvider

type AlertProvider struct {
	// Key used to authenticate the application sending
	// See "Your Applications" on the dashboard, or add a new one: https://pushover.net/apps/build
	ApplicationToken string `yaml:"application-token"`

	// Key of the user or group the messages should be sent to
	UserKey string `yaml:"user-key"`

	// The title of your message, likely the application name
	// default: the name of your application in Pushover
	Title string `yaml:"title,omitempty"`

	// Priority of all messages, ranging from -2 (very low) to 2 (Emergency)
	// default: 0
	Priority int `yaml:"priority,omitempty"`

	// Sound of the messages (see: https://pushover.net/api#sounds)
	// default: "" (pushover)
	Sound string `yaml:"sound,omitempty"`

	// DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type
	DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"`
}

AlertProvider is the configuration necessary for sending an alert using Pushover

func (*AlertProvider) GetDefaultAlert

func (provider *AlertProvider) GetDefaultAlert() *alert.Alert

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) IsValid

func (provider *AlertProvider) IsValid() bool

IsValid returns whether the provider's configuration is valid

func (*AlertProvider) Send

func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error

Send an alert using the provider Reference doc for pushover: https://pushover.net/api

type Body

type Body struct {
	Token    string `json:"token"`
	User     string `json:"user"`
	Title    string `json:"title,omitempty"`
	Message  string `json:"message"`
	Priority int    `json:"priority"`
	Sound    string `json:"sound,omitempty"`
}