webhook

Documentation

Index

• Constants
• func NewWebhookDest(url string) gadb.DestV1
• type POSTDataAlert
• type POSTDataAlertBundle
• type POSTDataAlertStatus
• type POSTDataAlertStatusBundle
• type POSTDataOnCallNotification
• type POSTDataOnCallUser
• type POSTDataTest
• type POSTDataVerification
• type Sender
  • func NewSender(ctx context.Context) *Sender
  • func (s *Sender) DisplayInfo(ctx context.Context, args map[string]string) (*nfydest.DisplayInfo, error)
  • func (Sender) ID() string
  • func (s *Sender) SendMessage(ctx context.Context, msg notification.Message) (*notification.SentMessage, error)
  • func (Sender) TypeInfo(ctx context.Context) (*nfydest.TypeInfo, error)
  • func (s *Sender) ValidateField(ctx context.Context, fieldID, value string) error

Constants

const (
	DestTypeWebhook  = "builtin-webhook"
	FieldWebhookURL  = "webhook_url"
	ParamBody        = "body"
	ParamContentType = "content_type"
	FallbackIconURL  = "builtin://webhook"
)

Functions

func NewWebhookDest

func NewWebhookDest(url string) gadb.DestV1

Types

type POSTDataAlert

type POSTDataAlert struct {
	AppName     string
	Type        string
	AlertID     int
	Summary     string
	Details     string
	ServiceID   string
	ServiceName string
	Meta        map[string]string
}

POSTDataAlert represents fields in outgoing alert notification.

type POSTDataAlertBundle

type POSTDataAlertBundle struct {
	AppName     string
	Type        string
	ServiceID   string
	ServiceName string
	Count       int
}

POSTDataAlertBundle represents fields in outgoing alert bundle notification.

type POSTDataAlertStatus

type POSTDataAlertStatus struct {
	AppName  string
	Type     string
	AlertID  int
	LogEntry string
}

POSTDataAlertStatus represents fields in outgoing alert status notification.

type POSTDataAlertStatusBundle

type POSTDataAlertStatusBundle struct {
	AppName  string
	Type     string
	AlertID  int
	LogEntry string
	Count    int
}

POSTDataAlertStatusBundle represents fields in outgoing alert status bundle notification.

type POSTDataOnCallNotification

type POSTDataOnCallNotification struct {
	AppName      string
	Type         string
	Users        []POSTDataOnCallUser
	ScheduleID   string
	ScheduleName string
	ScheduleURL  string
}

POSTDataOnCallNotification represents fields in outgoing on call notification.

type POSTDataOnCallUser

type POSTDataOnCallUser struct {
	ID   string
	Name string
	URL  string
}

POSTDataOnCallUser represents User fields in outgoing on call notification.

type POSTDataTest

type POSTDataTest struct {
	AppName string
	Type    string
}

POSTDataTest represents fields in outgoing test notification.

type POSTDataVerification

type POSTDataVerification struct {
	AppName string
	Type    string
	Code    string
}

POSTDataVerification represents fields in outgoing verification notification.

type Sender

type Sender struct{}

func NewSender

func NewSender(ctx context.Context) *Sender

func (*Sender) DisplayInfo

func (s *Sender) DisplayInfo(ctx context.Context, args map[string]string) (*nfydest.DisplayInfo, error)

func (Sender) ID

func (Sender) ID() string

func (*Sender) SendMessage

func (s *Sender) SendMessage(ctx context.Context, msg notification.Message) (*notification.SentMessage, error)

Send will send an alert for the provided message type

func (Sender) TypeInfo

func (Sender) TypeInfo(ctx context.Context) (*nfydest.TypeInfo, error)

func (*Sender) ValidateField

func (s *Sender) ValidateField(ctx context.Context, fieldID, value string) error