slack

Documentation

Overview

Package slack provides a notifier.Transport implementation for sending notifications to Slack

Index

• Variables
• type RichNotification
• type Transport
  • func NewTransport(key common.TransportKey, token string, opts ...slack.Option) *Transport
  • func (s *Transport) Key() common.TransportKey
  • func (s *Transport) Push(ctx context.Context, notification common.Notification) error
  • func (s *Transport) Validate(ctx context.Context) error

Variables

var ID = identifier.NewNamespaceAndKind("slack.com", identifier.KindID)

Types

type RichNotification

type RichNotification interface {
	common.Notification
	// GetSlackOptions returns the slack.MsgOptions to be used when sending the notification
	GetSlackOptions() []slack.MsgOption
}

RichNotification is an optional interface that can be implemented by any notification supporting Slack formatting

type Transport

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

Transport supports sending messages to Slack

func NewTransport

func NewTransport(key common.TransportKey, token string, opts ...slack.Option) *Transport

NewTransport creates a new Slack Transport It requires a TransportID, a Slack API token, and optionally some slack.Options

func (*Transport) Key

func (s *Transport) Key() common.TransportKey

func (*Transport) Push

func (s *Transport) Push(ctx context.Context, notification common.Notification) error

Push sends a notification to a Slack user In addition to supporting common.Notification, it also supports RichNotification for more complex messages that might include attachments, blocks, etc.

func (*Transport) Validate

func (s *Transport) Validate(ctx context.Context) error