ntfy

Documentation

Index

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

Constants

const (
	DefaultURL      = "https://ntfy.sh"
	DefaultPriority = 3
)

Types

type AlertProvider

type AlertProvider struct {
	Topic           string `yaml:"topic"`
	URL             string `yaml:"url,omitempty"`              // Defaults to DefaultURL
	Priority        int    `yaml:"priority,omitempty"`         // Defaults to DefaultPriority
	Token           string `yaml:"token,omitempty"`            // Defaults to ""
	Email           string `yaml:"email,omitempty"`            // Defaults to ""
	Click           string `yaml:"click,omitempty"`            // Defaults to ""
	DisableFirebase bool   `yaml:"disable-firebase,omitempty"` // Defaults to false
	DisableCache    bool   `yaml:"disable-cache,omitempty"`    // Defaults to false

	// 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 Slack

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(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error

Send an alert using the provider

type Body

type Body struct {
	Topic    string   `json:"topic"`
	Title    string   `json:"title"`
	Message  string   `json:"message"`
	Tags     []string `json:"tags"`
	Priority int      `json:"priority"`
	Email    string   `json:"email,omitempty"`
	Click    string   `json:"click,omitempty"`
}