pushover

README

Pushover

Package pushover provides a small interface to send messages via the Pushover service using its Message API.

This repository contains the Go pushover package, the pover command-line utility, and example Icinga2 configuration and scripts to send notifications from Icinga2 using pover.

Documentation

Overview

Package pushover provides a small interface to send messages via the Pushover service using its Message API. There is no client to set up or state to manage; just create a message and send it.

The most basic usage is sending a simple message. For example, to send "Hello World!":

msg := pushover.Message{
	User: "abcde12345",
	Token: "zxcvb6789",
	Message: "Hello World!"
}
if err := pushover.Push(msg); err != nil {
	return err
}

To send a message with high priority, with a title:

msg := pushover.Message{
	User: "abcde12345",
	Token: "zxcvb6789",
	Message: "Hello World!",
	Title: "Greeting",
	Priority: PriorityHigh,
}
if err := pushover.Push(msg); err != nil {
	return err
}

For more detailed example usage, see cmd/pover/pover.go

Index

• Constants
• func Push(m Message) error
• type Message

Constants

const (
	PriorityLowest = -2 + iota
	PriorityLow
	PriorityNormal
	PriorityHigh
)

const MaxMsgLength = 1024

const MaxTitleLength = 250

Functions

func Push

func Push(m Message) error

Push sends the Message m to Pushover.

Types

type Message

type Message struct {
	User     string
	Token    string
	Title    string
	Message  string
	Priority int
}

Message represents a message in the Pushover Message API.