webhook

Documentation

Overview

Package webhook contains the functionality for handling outcoming webhooks.

Index

• Constants
• func Send(endPoint EndPoint, data interface{}) error
• func SendAll(endPoints []EndPoint, data interface{})
• func SetTransport(tr *http.Transport)
• type EndPoint
• type Sender

Constants

const (

	// DefaultTimeoutSeconds is the number of seconds before a timeout occurs
	// when sending a webhook
	DefaultTimeoutSeconds = 10

	// MinHTTPStatusErrorCode is the lower bound of HTTP status codes which
	// indicate an error occurred
	MinHTTPStatusErrorCode = 400

	// SignatureHeader is the name of the HTTP header which contains the
	// webhook signature
	SignatureHeader = "X-Gophish-Signature"

	// Sha256Prefix is the prefix that specifies the hashing algorithm used
	// for the signature
	Sha256Prefix = "sha256"
)

Functions

func Send

func Send(endPoint EndPoint, data interface{}) error

Send sends data to a single EndPoint

func SendAll

func SendAll(endPoints []EndPoint, data interface{})

SendAll sends data to multiple EndPoints

func SetTransport

func SetTransport(tr *http.Transport)

SetTransport sets the underlying transport for the default webhook client.

Types

type EndPoint

type EndPoint struct {
	URL    string
	Secret string
}

EndPoint represents a URL to send the webhook to, as well as a secret used to sign the event

type Sender

type Sender interface {
	Send(endPoint EndPoint, data interface{}) error
}

Sender represents a type which can send webhooks to an EndPoint