webhook

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

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

Webhook names.

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.