ntfy

Documentation

Index

• Constants
• Variables
• type AlertProvider
  • func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error)
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, ...) error
  • func (provider *AlertProvider) Validate() error
  • func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error
• type Body
• type Config
  • func (cfg *Config) Merge(override *Config)
  • func (cfg *Config) Validate() error
• type Override

Constants

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

Variables

var (
	ErrInvalidToken           = errors.New("invalid token")
	ErrTopicNotSet            = errors.New("topic not set")
	ErrInvalidPriority        = errors.New("priority must between 1 and 5 inclusively")
	ErrDuplicateGroupOverride = errors.New("duplicate group override")
)

Types

type AlertProvider

type AlertProvider struct {
	DefaultConfig Config `yaml:",inline"`

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

	// Overrides is a list of Override that may be prioritized over the default configuration
	Overrides []Override `yaml:"overrides,omitempty"`
}

AlertProvider is the configuration necessary for sending an alert using Slack

func (*AlertProvider) GetConfig

func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error)

GetConfig returns the configuration for the provider with the overrides applied

func (*AlertProvider) GetDefaultAlert

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

GetDefaultAlert returns the provider's default alert configuration

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

func (*AlertProvider) Validate

func (provider *AlertProvider) Validate() error

Validate the provider's configuration

func (*AlertProvider) ValidateOverrides

func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error

ValidateOverrides validates the alert's provider override and, if present, the group override

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"`
}

type Config

type Config 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
}

func (*Config) Merge

func (cfg *Config) Merge(override *Config)

func (*Config) Validate

func (cfg *Config) Validate() error

type Override

type Override struct {
	Group  string `yaml:"group"`
	Config `yaml:",inline"`
}

Override is a case under which the default integration is overridden