slackhook

README

Slackhook

Simple client for Slack web hook URLs

Documentation

Index

• Constants
• func NoOpLogger(ctx context.Context, msg string, args ...any)
• type Attachment
• type Client
  • func New(hookURL string) *Client
  • func (sc *Client) Post(ctx context.Context, l Logger, cl *http.Client, msg Message) (err error)
  • func (c *Client) Set(hookURL string) error
  • func (c *Client) String() string
• type Field
• type Logger
• type Message

Constants

const MockClient = "slack://mock"

Magic URL to use a mock client in dev.

Functions

func NoOpLogger

func NoOpLogger(ctx context.Context, msg string, args ...any)

NoOpLogger does nothing with log messages.

Types

type Attachment

type Attachment struct {
	Pretext   string  `json:"pretext,omitempty"`
	Fallback  string  `json:"fallback"`
	Color     string  `json:"color,omitempty"`
	Title     string  `json:"title,omitempty"`
	TitleLink string  `json:"title_link,omitempty"`
	Text      string  `json:"text,omitempty"`
	TimeStamp int64   `json:"ts,omitempty"`
	Fields    []Field `json:"fields,omitempty"`
}

type Client

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

Client posts messages to a Slack webhook URL.

func New

func New(hookURL string) *Client

New returns a new client with the hookURL set.

func (*Client) Post

func (sc *Client) Post(ctx context.Context, l Logger, cl *http.Client, msg Message) (err error)

Post message to Slack. Logger must not be nil. Uses http.DefaultClient if cl is nil. Returns an error if response is not 200 OK.

func (*Client) Set

func (c *Client) Set(hookURL string) error

Set the hookURL for a Client. If hookURL is MockClient, Client will use a mock client. Set is part of the flag.Value interface.

func (*Client) String

func (c *Client) String() string

String is part of the flag.Value interface.

type Field

type Field struct {
	Title string `json:"title"`
	Value string `json:"value"`
	Short bool   `json:"short"`
}

type Logger

type Logger = func(ctx context.Context, msg string, args ...any)

Logger is any function that behaves like slog.InfoContext, slog.DebugContext, etc.

type Message

type Message struct {
	Text        string       `json:"text"`
	Attachments []Attachment `json:"attachments"`
}

Message is the JSON object expected by Slack