notification

Documentation

Index

• Constants
• type Config
• type EventType
• type Sender
  • func NewWebhookSender(config Config) Sender
• type Status

Constants

const (
	ReceivedPayload EventType = 1
	Failure         Status    = 0
	Success         Status    = 1
)

Constants defined for notification delivery.

Types

type Config

type Config interface {
	GetReceiveEventNotificationEndpoint() string
}

Config defines methods required for this package.

type EventType

type EventType int

EventType is the type of the notification.

type Sender

type Sender interface {
	Send(notification *notificationpb.NotificationMessage) (Status, error)
}

Sender defines methods that can handle a notification.

func NewWebhookSender

func NewWebhookSender(config Config) Sender

NewWebhookSender returns an implementation of a Sender that sends notifications through webhooks.

type Status

type Status int

Status defines the status of the notification.