webhook

Documentation

Index

• type Message
• type Notifier
  • func New(cfg *profile.WebhookConfig, tmpl *template.Template, ...) (*Notifier, error)
  • func (n *Notifier) CustomConfig(ctx context.Context) (*profile.WebhookConfig, error)
  • func (n *Notifier) Notify(ctx context.Context, alerts ...*alert.Alert) (bool, error)
  • func (n *Notifier) SendResolved() bool

Types

type Message

type Message struct {
	*template.Data

	// The protocol version.
	Version         string `json:"version"`
	GroupKey        string `json:"groupKey"`
	TruncatedAlerts uint64 `json:"truncatedAlerts"`
}

Message is the data structure of the webhook message. It is passed to the webhook server.

type Notifier

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

Notifier email notifier

tmpl include all of receiver's template.

func New

func New(cfg *profile.WebhookConfig, tmpl *template.Template,
	fn notify.CustomerConfigFunc[profile.WebhookConfig],
) (*Notifier, error)

New returns a new Webhook.

func (*Notifier) CustomConfig

func (n *Notifier) CustomConfig(ctx context.Context) (*profile.WebhookConfig, error)

CustomConfig returns a custom config for the notifier.

func (*Notifier) Notify

func (n *Notifier) Notify(ctx context.Context, alerts ...*alert.Alert) (bool, error)

Notify implements the Notifier interface.

func (*Notifier) SendResolved

func (n *Notifier) SendResolved() bool