slack

Documentation

Index

• func VerifySlackRequest(ctx context.Context, key string, headers map[string]string, body string) bool
• type Kit
  • func NewKit(token string, config RetryConfig) Kit
  • func (s *Kit) GetAllChannels(ctx context.Context) ([]slack.Channel, error)
  • func (s *Kit) GetFullCommandRequest(ctx context.Context, body string) (SlashCommandRequest, error)
  • func (s Kit) PostMessage(ctx context.Context, channelID string, channelName string, ...) (PostMessageResult, error)
• type OriginalSlashCommandRequest
• type PostMessageResult
• type PostMessageResultType
• type RetryConfig
• type SlashCommandRequest

Functions

func VerifySlackRequest

func VerifySlackRequest(ctx context.Context, key string, headers map[string]string, body string) bool

https://api.slack.com/authentication/verifying-requests-from-slack

Types

type Kit

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

func NewKit

func NewKit(token string, config RetryConfig) Kit

func (*Kit) GetAllChannels

func (s *Kit) GetAllChannels(ctx context.Context) ([]slack.Channel, error)

https://api.slack.com/docs/conversations-api https://api.slack.com/methods/conversations.list

Required scopes:

• channels:read (public channels)
• groups:read (private channels)

func (*Kit) GetFullCommandRequest

func (s *Kit) GetFullCommandRequest(ctx context.Context, body string) (SlashCommandRequest, error)

GetFullCommandRequest to retrieve correct channel name for "private group"s. Before March 2021, a private channel was "private group" in Slack implementation. And slash command payloads which Slack sends to us, contains wrong channel name info for private groups. So we need retrieve the correct channel name via Slack API. https://api.slack.com/types/group

func (Kit) PostMessage

func (s Kit) PostMessage(ctx context.Context, channelID string, channelName string, payload map[string]interface{}) (PostMessageResult, error)

https://api.slack.com/methods/chat.postMessage

type OriginalSlashCommandRequest

type OriginalSlashCommandRequest struct {
	Command             string
	ChannelID           string
	OriginalChannelName string
	Text                string
}

type PostMessageResult

type PostMessageResult struct {
	Type PostMessageResultType
	// Only when Type is ServerFailure
	StatusCode int
	Body       string
	// Only when Type is DomainFailure
	Reason      string
	ChannelID   string
	ChannelName string
}

Pack all neccessary fields into one struct to work-around no enum.

type PostMessageResultType

type PostMessageResultType int

const (
	PostMessageResultOK PostMessageResultType = iota
	PostMessageResultServerTimeoutFailure
	PostMessageResultServerFailure
	PostMessageResultDomainFailure
)

type RetryConfig

type RetryConfig struct {
	Max     int
	WaitMin time.Duration
	WaitMax time.Duration
	// Includes TCP connection establishment, TLS handshake, send HTTP request, read response body.
	ReadTimeout time.Duration
}

type SlashCommandRequest

type SlashCommandRequest struct {
	OriginalSlashCommandRequest
	ChannelName string
	Supported   bool
}