api

Documentation

Index

• Constants
• func Post(ctx context.Context, botToken, slackMethod string, body, resp any) error
• type AppsConnectionsOpenResponse
  • func AppsConnectionsOpen(ctx context.Context, appToken string) (*AppsConnectionsOpenResponse, error)
• type AuthTestResponse
  • func AuthTest(ctx context.Context, botToken string) (*AuthTestResponse, error)
• type Bot
  • func BotsInfo(ctx context.Context, botToken string, authTest *AuthTestResponse) (*Bot, error)
• type BotsInfoResponse
• type ResponseMetadata
• type SlackResponse

Constants

const (
	HeaderContentType = "Content-Type"

	ContentTypeJSON            = "application/json"                // Accept
	ContentTypeJSONCharsetUTF8 = "application/json; charset=utf-8" // Content-Type
	ContentTypeForm            = "application/x-www-form-urlencoded"
)

Functions

func Post

func Post(ctx context.Context, botToken, slackMethod string, body, resp any) error

Post is a helper function to make an HTTP POST request with a JSON body to the Slack API. Use case 1: connection initialization (AuthTest and AppsConnectionsOpen API calls). Use case 2: send updates to Slack webhooks when we finish processing interaction events (https://api.slack.com/interactivity/handling#updating_message_response).

Types

type AppsConnectionsOpenResponse

type AppsConnectionsOpenResponse struct {
	SlackResponse

	URL string `json:"url"`
}

https://api.slack.com/methods/apps.connections.open#examples

func AppsConnectionsOpen

func AppsConnectionsOpen(ctx context.Context, appToken string) (*AppsConnectionsOpenResponse, error)

AppsConnectionsOpen generates a temporary WebSocket URL for a Socket Mode app, to check the usability of an app-level token provided by the user. Based on: https://api.slack.com/methods/apps.connections.open Required Slack app scope: https://api.slack.com/scopes/connections:write

type AuthTestResponse

type AuthTestResponse struct {
	SlackResponse

	URL                 string `json:"url"`
	Team                string `json:"team"`
	User                string `json:"user"`
	TeamID              string `json:"team_id"`
	UserID              string `json:"user_id"`
	BotID               string `json:"bot_id"`
	EnterpriseID        string `json:"enterprise_id,omitempty"`
	IsEnterpriseInstall bool   `json:"is_enterprise_install"`
}

https://api.slack.com/methods/auth.test#examples

func AuthTest

func AuthTest(ctx context.Context, botToken string) (*AuthTestResponse, error)

AuthTest checks the caller's authentication & identity. Based on: https://api.slack.com/methods/auth.test (no scopes required).

type Bot

type Bot struct {
	ID      string            `json:"id"`
	Deleted bool              `json:"deleted"`
	Name    string            `json:"name"`
	Updated int               `json:"updated"`
	AppID   string            `json:"app_id"`
	UserID  string            `json:"user_id"`
	Icons   map[string]string `json:"icons"`
}

https://api.slack.com/methods/bots.info#examples

func BotsInfo

func BotsInfo(ctx context.Context, botToken string, authTest *AuthTestResponse) (*Bot, error)

BotsInfo gets information about a bot user. Based on: https://api.slack.com/methods/bots.info Required Slack app scope: https://api.slack.com/scopes/users:read

type BotsInfoResponse

type BotsInfoResponse struct {
	SlackResponse

	Bot Bot `json:"bot"`
}

https://api.slack.com/methods/bots.info#examples

type ResponseMetadata

type ResponseMetadata struct {
	Messages   []string `json:"messages,omitempty"`
	Warnings   []string `json:"warnings,omitempty"`
	NextCursor string   `json:"next_cursor,omitempty"`
}

type SlackResponse

type SlackResponse struct {
	OK               bool              `json:"ok"`
	Warning          string            `json:"warning,omitempty"`
	Error            string            `json:"error,omitempty"`
	ResponseMetadata *ResponseMetadata `json:"response_metadata,omitempty"`
}