webhook

package

v0.0.0-...-8c17a97 Latest Latest Go to latest Published: May 28, 2018 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/j7b/mailgun

Links

Open Source Insights

Documentation ¶

Overview ¶

Package webhook implements webhook API endpoints.

Note docs say "Mailgun imposes a rate limit for the Webhook API endpoint. Users may issue no more than 300 requests per minute, per account."

Callers with grave concerns about this should see bugs section.

Index ¶

Constants
func Delete(c client.Caller, name Hook) error
func New(c client.Caller, name Hook, url string) error
func URL(c client.Caller, name Hook) (fmt.Stringer, error)
func Update(c client.Caller, name Hook, url string) error
type Hook
type Webhook
type Webhooks
- func Get(c client.Caller) (*Webhooks, error)
Bugs

Constants ¶

View Source

const (
	Bounce      = hook(`bounce`)
	Deliver     = hook(`deliver`)
	Drop        = hook(`drop`)
	Spam        = hook(`spam`)
	Unsubscribe = hook(`unsubscribe`)
	Click       = hook(`click`)
	Open        = hook(`open`)
)

Webhook names.

Variables ¶

This section is empty.

Functions ¶

func Delete ¶

func Delete(c client.Caller, name Hook) error

Delete webhook.

func New ¶

func New(c client.Caller, name Hook, url string) error

New creates a new webhook for name.

func URL ¶

func URL(c client.Caller, name Hook) (fmt.Stringer, error)

URL returns the URL for webhook name.

func Update ¶

func Update(c client.Caller, name Hook, url string) error

Update webhook url.

Types ¶

type Hook ¶

type Hook interface {
	// contains filtered or unexported methods
}

Hook is an interface for webhook names.

type Webhook ¶

type Webhook struct {
	URL string `json:"url"`
}

Webhook is a webhook URL.

type Webhooks ¶

type Webhooks struct {
	Bounce      Webhook `json:"bounce"`
	Deliver     Webhook `json:"deliver"`
	Drop        Webhook `json:"drop"`
	Spam        Webhook `json:"spam"`
	Unsubscribe Webhook `json:"unsubscribe"`
	Click       Webhook `json:"click"`
	Open        Webhook `json:"open"`
}

Webhooks are the set of webhooks supported by a domain.

func Get ¶

func Get(c client.Caller) (*Webhooks, error)

Get retrieves Webhooks for API domain.

Notes ¶

Bugs ¶

https://documentation.mailgun.com/en/latest/api-webhooks.html#webhooks is painfully incorrect.
Callers should feel free to inspect retry-seconds themselves.

Source Files ¶

View all Source files

webhook.go

Directories ¶

Path	Synopsis
handler Package handler implements types for webhook consumption.	Package handler implements types for webhook consumption.
types Package types defines webhook types.	Package types defines webhook types.
_gen

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL