discordwebhook

Documentation

Overview

Package discordwebhook is a simple low-level HTTP client wrapper around Discord webhooks.

Index

• func Send(whurl string, w Webhook) *http.Request
• func Validate(resp *http.Response) error
• type EmbedAuthor
• type EmbedField
• type EmbedFooter
• type Embeds
• type Webhook

Functions

func Send

func Send(whurl string, w Webhook) *http.Request

Send returns a request for a Discord webhook.

func Validate

func Validate(resp *http.Response) error

Validate validates the response from Discord.

Types

type EmbedAuthor

type EmbedAuthor struct {
	Name    string `json:"name"`
	URL     string `json:"url"`
	IconURL string `json:"icon_url"`
}

type EmbedField

type EmbedField struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	Inline bool   `json:"inline"`
}

EmbedField is an individual field being embedded in a message.

type EmbedFooter

type EmbedFooter struct {
	Text    string `json:"text"`
	IconURL string `json:"icon_url"`
}

EmbedFooter is the message footer.

type Embeds

type Embeds struct {
	Title       string       `json:"title,omitempty"`
	Description string       `json:"description,omitempty"`
	URL         string       `json:"url,omitempty"`
	Author      *EmbedAuthor `json:"author,omitempty"`
	Fields      []EmbedField `json:"fields,omitempty"`
	Footer      *EmbedFooter `json:"footer,omitempty"`
}

Embeds is a set of embed fields and a footer.

type Webhook

type Webhook struct {
	Content         string              `json:"content,omitempty"`
	Username        string              `json:"username,omitempty"`
	AvatarURL       string              `json:"avatar_url"`
	Embeds          []Embeds            `json:"embeds,omitempty"`
	AllowedMentions map[string][]string `json:"allowed_mentions"`
}

Webhook is the parent structure fired off to Discord.