webhook

Documentation

Index

• type WebHook
• type WebHookConfig
  • func DefaultConfig() WebHookConfig
  • func (cfg WebHookConfig) IsValid() (bool, error)
• type WebHookManager
  • func NewWebHookManager(whs map[string]WebHook) *WebHookManager
  • func NewWebHookManagerFromConfig(cfg WebHookConfig, log logger.Logger) (*WebHookManager, error)
  • func (m *WebHookManager) AddWebHook(name string, wh WebHook)
  • func (m *WebHookManager) Alert(msg interface{}) error
  • func (m *WebHookManager) Error(msg interface{}) error
  • func (m *WebHookManager) Info(msg interface{}) error
  • func (m *WebHookManager) RemoveWebHook(name string)
  • func (m *WebHookManager) Start() error
  • func (m *WebHookManager) Stop()

Types

type WebHook

type WebHook interface {
	// Start starts the service.
	Start() error

	// Stop terminates the service.
	Stop()

	// Ping checks if the service is alive.
	Ping() error

	// Alert posts an alert message to the WebHook.
	Alert(msg interface{}) error

	// Info posts an info message to the WebHook.
	Info(msg interface{}) error

	// Error posts an error message to the WebHook.
	Error(msg interface{}) error
}

WebHook specifies necessary methods for a webhook service.

type WebHookConfig

type WebHookConfig struct {
	Discord *discord.DiscordConfig `json:"Discord,omitempty"`

	Telegram *telegram.TeleConfig `json:"Telegram,omitempty"`
}

func DefaultConfig

func DefaultConfig() WebHookConfig

func (WebHookConfig) IsValid

func (cfg WebHookConfig) IsValid() (bool, error)

type WebHookManager

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

WebHookManager manages the list of WebHooks and is the main entrance to posting messages.

func NewWebHookManager

func NewWebHookManager(whs map[string]WebHook) *WebHookManager

NewWebHookManager returns a new WebHookManager.

func NewWebHookManagerFromConfig

func NewWebHookManagerFromConfig(cfg WebHookConfig, log logger.Logger) (*WebHookManager, error)

NewWebHookManagerFromConfig returns a new WebHookManager from the given config.

func (*WebHookManager) AddWebHook

func (m *WebHookManager) AddWebHook(name string, wh WebHook)

AddWebHook adds a new WebHook to the WebHookManager.

func (*WebHookManager) Alert

func (m *WebHookManager) Alert(msg interface{}) error

Alert pushes the given alert message to the WebHook's.

func (*WebHookManager) Error

func (m *WebHookManager) Error(msg interface{}) error

Error pushes the given error message to the WebHook's.

func (*WebHookManager) Info

func (m *WebHookManager) Info(msg interface{}) error

Info pushes the given information message to the WebHook's.

func (*WebHookManager) RemoveWebHook

func (m *WebHookManager) RemoveWebHook(name string)

RemoveWebHook removes a WebHook given its name.

func (*WebHookManager) Start

func (m *WebHookManager) Start() error

Start starts all the WebHook of the WebHookManager.

func (*WebHookManager) Stop

func (m *WebHookManager) Stop()

Stop terminates all the processes of the WebHookManager.