ntfy

Documentation

Index

• Variables
• func Notify(ctx context.Context, text string, options ...Option) (err error)
• func R() *resty.Request
• type Config
  • func C() Config
• type DingtalkConfig
  • func (DingtalkConfig) Name() string
  • func (c DingtalkConfig) Notify(_ context.Context, text string, _ ...Option) error
  • func (c DingtalkConfig) Sign() (string, string)
• type Interface
• type Option
  • func WithExtra(extra map[string]string) Option
  • func WithHeader(headers map[string]string) Option
• type Options
• type TelegramConfig
  • func (TelegramConfig) Name() string
  • func (c TelegramConfig) Notify(_ context.Context, text string, _ ...Option) error
• type WebhookConfig
  • func (c WebhookConfig) Name() string
  • func (c WebhookConfig) Notify(_ context.Context, text string, options ...Option) error
• type WeixinWorkConfig
  • func (WeixinWorkConfig) Name() string
  • func (c WeixinWorkConfig) Notify(_ context.Context, text string, _ ...Option) error

Variables

var ErrNoConfig = errors.New("no notify config")

Functions

func Notify

func Notify(ctx context.Context, text string, options ...Option) (err error)

func R

func R() *resty.Request

Types

type Config

type Config struct {
	Timeout time.Duration `json:"ntfy.timeout" yaml:"ntfy.timeout"`
	Proxy   string        `json:"ntfy.proxy"   yaml:"ntfy.proxy"`
	Retry   int           `json:"ntfy.retry"   yaml:"ntfy.retry"`

	DingtalkConfig   `yaml:",squash"`
	TelegramConfig   `yaml:",squash"`
	WeixinWorkConfig `yaml:",squash"`

	WebhookConfig `yaml:",squash"`
}

func C

func C() Config

type DingtalkConfig

type DingtalkConfig struct {
	Token  *string `json:"ntfy.dingtalk.token"  yaml:"ntfy.dingtalk.token"`
	Secret string  `json:"ntfy.dingtalk.secret" yaml:"ntfy.dingtalk.secret"`
}

func (DingtalkConfig) Name

func (DingtalkConfig) Name() string

func (DingtalkConfig) Notify

func (c DingtalkConfig) Notify(_ context.Context, text string, _ ...Option) error

func (DingtalkConfig) Sign

func (c DingtalkConfig) Sign() (string, string)

type Interface

type Interface interface {
	Name() string
	Notify(ctx context.Context, text string, options ...Option) error
}

type Option

type Option = optionutil.I[Options]

func WithExtra

func WithExtra(extra map[string]string) Option

func WithHeader

func WithHeader(headers map[string]string) Option

type Options

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

type TelegramConfig

type TelegramConfig struct {
	Token  *string `json:"ntfy.telegram.token"   yaml:"ntfy.telegram.token"`
	ChatId string  `json:"ntfy.telegram.chat_id" yaml:"ntfy.telegram.chat_id"`
}

func (TelegramConfig) Name

func (TelegramConfig) Name() string

func (TelegramConfig) Notify

func (c TelegramConfig) Notify(_ context.Context, text string, _ ...Option) error

type WebhookConfig

type WebhookConfig struct {
	URL *string `json:"ntfy.webhook.url" yaml:"ntfy.webhook.url"`
	// optional: GET or POST, default is GET
	Method string `json:"ntfy.webhook.method" yaml:"ntfy.webhook.method"`
	// only available when method is POST
	// optional: JSON or FORM, default is FORM
	//  - FORM is request by `application/x-www-form-urlencoded`
	//  - JSON is request by `application/json`
	Type string `json:"ntfy.webhook.type" yaml:"ntfy.webhook.type"`
	// the key of text in request body or query string
	// default is text
	Key string `json:"ntfy.webhook.key" yaml:"ntfy.webhook.key"`
	// extra values
	Extra map[string]string `json:"ntfy.webhook.extra" yaml:"ntfy.webhook.extra"`
	// headers
	Headers map[string]string `json:"ntfy.webhook.headers" yaml:"ntfy.webhook.headers"`
}

WebhookConfig is the config for webhook.

ServerChan [docs](https://sct.ftqq.com/sendkey)

ntfy:
  webhook:
    url: https://sctapi.ftqq.com/{key}.send
    method: POST
    type: JSON
    key: desp
    extras:
      title: ntfy

ntfy.sh [docs](https://docs.ntfy.sh/publish/#publish-as-json)

ntfy:
 webhook:
   url: https://ntfy.com/
   method: POST
   type: JSON
   key: message
   extra:
     title: ntfy
     topic: default
   headers:
     Authorization: Basic base64(username:password)

func (WebhookConfig) Name

func (c WebhookConfig) Name() string

func (WebhookConfig) Notify

func (c WebhookConfig) Notify(_ context.Context, text string, options ...Option) error

type WeixinWorkConfig

type WeixinWorkConfig struct {
	Key *string `json:"ntfy.weixin_work.key" yaml:"ntfy.weixin_work.key"`
}

func (WeixinWorkConfig) Name

func (WeixinWorkConfig) Name() string

func (WeixinWorkConfig) Notify

func (c WeixinWorkConfig) Notify(_ context.Context, text string, _ ...Option) error