messagebird

Documentation

Index

• type AlertProvider
  • func (provider AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) IsValid() bool
  • func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, ...) error
• type Body

Types

type AlertProvider

type AlertProvider struct {
	AccessKey  string `yaml:"access-key"`
	Originator string `yaml:"originator"`
	Recipients string `yaml:"recipients"`

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

AlertProvider is the configuration necessary for sending an alert using Messagebird

func (AlertProvider) GetDefaultAlert

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

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) IsValid

func (provider *AlertProvider) IsValid() bool

IsValid returns whether the provider's configuration is valid

func (*AlertProvider) Send

func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error

Send an alert using the provider Reference doc for messagebird: https://developers.messagebird.com/api/sms-messaging/#send-outbound-sms

type Body

type Body struct {
	Originator string `json:"originator"`
	Recipients string `json:"recipients"`
	Body       string `json:"body"`
}