slack

README

Slack

go-slack is a Go library for the Slack API.

Features

• Slack Webhook Support.
• Slack chat.postMessage Support.
• Client Interface - Use alternative implementations - currently webhook is the only client.
• Logrus Hook Support - Automatically send messages to Slack when using a Logrus logger.

Installation

go get -u github.com/multiplay/go-slack

Examples

The simplest way to use go-slack is to create a webhook client and send chat messages using it e.g.

package main

import (
	"github.com/multiplay/go-slack/chat"
	"github.com/multiplay/go-slack/webhook"
)

func main() {
	c := webhook.New("https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX")
	m := &chat.Message{Text: "test message"}
	m.Send(c)
}

If your using logrus you can use the webhook to post to slack based on your logging e.g.

package main

import (
	"github.com/multiplay/go-slack/lrhook"
	"github.com/multiplay/go-slack/chat"
	"github.com/sirupsen/logrus"
)

func main() {
	cfg := lrhook.Config{
		MinLevel:       logrus.ErrorLevel,
		Message:	chat.Message{
			Channel:	"#slack-testing",
			IconEmoji:	":ghost:",
		},
	}
	h := lrhook.New(cfg, "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX")
	logrus.SetFormatter(&logrus.JSONFormatter{})
	logrus.SetLevel(logrus.InfoLevel)
	logrus.AddHook(h)
	logrus.Error("my error")
}

Documentation

• GoDoc API Reference.

License

go-slack is available under the BSD 2-Clause License.

Documentation

Overview

Package slack provides a generic interface for slack clients and some basic types to enable the creation of slack clients.

See the webhook sub directory for an example of such a client.

Index

• type Client
• type Error
  • func NewError(statuscode int, msg string) *Error
  • func (e *Error) Error() string
• type Response
  • func (r Response) Err() string
  • func (r Response) Ok() bool
  • func (r Response) Warn() string
• type SendResponse

Types

type Client

type Client interface {
	// Send sends the request to slack.
	Send(url string, message, response interface{}) error
}

Client represents a slack client.

type Error

type Error struct {
	// StatusCode is the status code returned by the request.
	StatusCode int

	// Message is the message, if any, returned in the body.
	Message string
}

Error represents an error from the Slack API.

func NewError

func NewError(statuscode int, msg string) *Error

NewError returns a new slack error with statuscode and msg.

func (*Error) Error

func (e *Error) Error() string

type Response

type Response struct {
	OK      bool   `json:"ok"`
	Error   string `json:"error,omitempty"`
	Warning string `json:"warning,omitempty"`
}

Response is a generic response from slack which implements SendResponse.

func (Response) Err

func (r Response) Err() string

Err implements SendResponse.Err.

func (Response) Ok

func (r Response) Ok() bool

Ok implements SendResponse.Ok.

func (Response) Warn

func (r Response) Warn() string

Warn implements SendResponse.Warn.

type SendResponse

type SendResponse interface {
	Ok() bool
	Err() string
	Warn() string
}

SendResponse is the interface that responses implement.