webhook

Documentation

Index

• type Client
  • func (w *Client) Submit(r event.AuthRequest) (*event.AuthResponse, error)
• type Driver
  • func (Driver) New(opts map[string]string) (dispatch.WorkerClient, error)

Types

type Client

type Client struct {
	// URL is the HTTPS URL to a worker
	URL string

	// Header is the HTTP header used to set the access token
	// Header defaults to X-Access-Token
	Header string

	// Token is an authorization token used to communicate with the worker
	Token string
}

Client implements the dispatch.WorkerClient interface for webhooks.

func (*Client) Submit

func (w *Client) Submit(r event.AuthRequest) (*event.AuthResponse, error)

Submit fulfils the dispatch.WorkerClient interface and submits a task to the configured webhook server.

type Driver

type Driver struct{}

Driver implements the dispatch.WorkerClient interface.

func (Driver) New

func (Driver) New(opts map[string]string) (dispatch.WorkerClient, error)

New is used to create a webhook worker client and accepts the following configuration options:

url:    an HTTPS link to the webhook server.
token:  a shared secret used to authenticate the client to the webhook server.
header: the HTTP header used for authentication (defaults to X-Access-Token).