webhooks

Documentation

Index

• Constants
• Variables
• type Broadcaster
• type Event
  • func (a Event) String() string
• type HeaderOption
  • func WithBasicAuth(username, password string) HeaderOption
• type Manager
  • func NewManager(store WebhookStore, logger *zap.Logger) (*Manager, error)
  • func (m *Manager) BroadcastAction(_ context.Context, event Event) error
  • func (m *Manager) Delete(ctx context.Context, wh Webhook) error
  • func (m *Manager) Info() ([]Webhook, []WebhookQueueInfo)
  • func (m *Manager) Register(ctx context.Context, wh Webhook) error
  • func (m *Manager) Shutdown(ctx context.Context) error
• type NoopBroadcaster
  • func (NoopBroadcaster) BroadcastAction(_ context.Context, _ Event) error
• type Webhook
  • func (w Webhook) Matches(action Event) bool
  • func (w Webhook) String() string
• type WebhookQueueInfo
• type WebhookStore

Constants

const (
	WebhookEventPing = "ping"
)

Variables

var ErrWebhookNotFound = errors.New("Webhook not found")

Types

type Broadcaster

type Broadcaster interface {
	BroadcastAction(ctx context.Context, action Event) error
}

type Event

type Event struct {
	Module  string      `json:"module"`
	Event   string      `json:"event"`
	Payload interface{} `json:"payload,omitempty"`
}

Event describes an event that has been triggered.

func (Event) String

func (a Event) String() string

type HeaderOption

type HeaderOption func(headers map[string]string)

func WithBasicAuth

func WithBasicAuth(username, password string) HeaderOption

type Manager

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

func NewManager

func NewManager(store WebhookStore, logger *zap.Logger) (*Manager, error)

func (*Manager) BroadcastAction

func (m *Manager) BroadcastAction(_ context.Context, event Event) error

func (*Manager) Delete

func (m *Manager) Delete(ctx context.Context, wh Webhook) error

func (*Manager) Info

func (m *Manager) Info() ([]Webhook, []WebhookQueueInfo)

func (*Manager) Register

func (m *Manager) Register(ctx context.Context, wh Webhook) error

func (*Manager) Shutdown

func (m *Manager) Shutdown(ctx context.Context) error

type NoopBroadcaster

type NoopBroadcaster struct{}

func (NoopBroadcaster) BroadcastAction

func (NoopBroadcaster) BroadcastAction(_ context.Context, _ Event) error

type Webhook

type Webhook struct {
	Module  string            `json:"module"`
	Event   string            `json:"event"`
	URL     string            `json:"url"`
	Headers map[string]string `json:"headers,omitempty"`
}

func (Webhook) Matches

func (w Webhook) Matches(action Event) bool

func (Webhook) String

func (w Webhook) String() string

type WebhookQueueInfo

type WebhookQueueInfo struct {
	URL  string `json:"url"`
	Size int    `json:"size"`
}

type WebhookStore

type WebhookStore interface {
	DeleteWebhook(ctx context.Context, wh Webhook) error
	AddWebhook(ctx context.Context, wh Webhook) error
	Webhooks(ctx context.Context) ([]Webhook, error)
}