proxy

Documentation

Index

• type Config
• type Proxy
  • func New(cfg *Config, source hookdeck.Source, connections []hookdeck.Connection) *Proxy
  • func (p *Proxy) Run(parentCtx context.Context) error

Types

type Config

type Config struct {
	// DeviceName is the name of the device sent to Hookdeck to help identify the device
	DeviceName string
	Profile    config.Profile
	// Key is the API key used to authenticate with Hookdeck
	Key              string
	URL              *url.URL
	APIBaseURL       string
	DashboardBaseURL string
	ConsoleBaseURL   string
	WSBaseURL        string
	// Indicates whether to print full JSON objects to stdout
	PrintJSON bool
	Log       *log.Logger
	// Force use of unencrypted ws:// protocol instead of wss://
	NoWSS    bool
	Insecure bool
}

Config provides the configuration of a Proxy

type Proxy

type Proxy struct {
	// contains filtered or unexported fields
}

A Proxy opens a websocket connection with Hookdeck, listens for incoming webhook events, forwards them to the local endpoint and sends the response back to Hookdeck.

func New

func New(cfg *Config, source hookdeck.Source, connections []hookdeck.Connection) *Proxy

New creates a new Proxy

func (*Proxy) Run

func (p *Proxy) Run(parentCtx context.Context) error

Run manages the connection to Hookdeck. The connection is established in phases:

• Create a new CLI session
• Create a new websocket connection