ntfy

Documentation

Overview

Package ntfy implements a Pilot notification plugin that sends events to an ntfy server (ntfy.sh or self-hosted).

Index

• type Config
• type Notifier
  • func New(cfg Config) *Notifier
  • func (n *Notifier) Name() string
  • func (n *Notifier) Notify(ctx context.Context, event plugin.NotificationEvent) error
  • func (n *Notifier) Test(ctx context.Context) error

Types

type Config

type Config struct {
	URL      string `json:"url"`
	Topic    string `json:"topic"`
	Token    string `json:"token,omitempty"`
	Priority int    `json:"priority,omitempty"`
}

Config holds the user-supplied settings for an ntfy notifier.

type Notifier

type Notifier struct {
	// contains filtered or unexported fields
}

Notifier is an ntfy notifier plugin instance.

func New

func New(cfg Config) *Notifier

New creates a new Notifier from the given config.

func (*Notifier) Name

func (n *Notifier) Name() string

func (*Notifier) Notify

func (n *Notifier) Notify(ctx context.Context, event plugin.NotificationEvent) error

Notify sends the event as an ntfy message.

func (*Notifier) Test

func (n *Notifier) Test(ctx context.Context) error

Test sends a test message with the "test" tag.