webhook

README

wrp-listener

wrp-listener is a library that provides a webhook registerer and a validation function to be used for authentication.

Summary

Wrp-listener provides packages to help a consumer register to a webhook and authenticate messages received. Registering to a webhook can be done directly or set up to run at an interval. Message authentication is set up to work with the bascule library.

Table of Contents

• Code of Conduct
• Details
• Contributing

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

Details

Authentication

Authentication is done using the bascule library: the token factory provided in the hashTokenFactory package can be given to the bascule Constructor middleware in order to verify that the hashed body given with a request is valid and created with the expected secret.

Registering

Registration happens through the webhookClient package, and can be set up for manual registration or registration at an interval. If the consumer of this package decides when to register, an error is returned if registering a webhook is not successful. With registering at an interval, a logger can be provided.
Then, if an error occurs, the registerer will log it and then try again at the next interval.

Contributing

Refer to CONTRIBUTING.md.

Documentation

Index

• type Config
• type Matcher
• type W

Types

type Config

type Config struct {
	// The URL to deliver messages to.
	URL string `json:"url"`

	// The content-type to set the messages to (unless specified by WRP).
	ContentType string `json:"content_type"`

	// The secret to use for the SHA1 HMAC.
	// Optional, set to "" to disable behavior.
	Secret string `json:"secret,omitempty"`

	// The max number of times to retry for webhook
	MaxRetryCount int `json:"max_retry_count,omitempty"`

	// alt_urls is a list of explicit URLs that should be round robin on faliure
	AlternativeURLs []string `json:"alt_urls,omitempty"`
}

Configuration for message delivery

type Matcher

type Matcher struct {
	// The list of regular expressions to match device id type against.
	DeviceID []string `json:"device_id"`
}

Matcher type contains values to match against the metadata.

type W

type W struct {
	// Configuration for message delivery
	Config Config `json:"config"`

	// The URL to notify when we cut off a client due to overflow.
	// Optional, set to "" to disable behavior
	FailureURL string `json:"failure_url"`

	// The list of regular expressions to match event type against.
	Events []string `json:"events"`

	// Matcher type contains values to match against the metadata.
	Matcher Matcher `json:"matcher,omitempty"`

	// The specified duration for this hook to live
	Duration time.Duration `json:"duration"`

	// The absolute time when this hook is to be disabled
	Until time.Time `json:"until"`

	// The address that performed the registration
	Address string `json:"registered_from_address"`
}

W is the structure that represents the Webhook listener data we share.

(Note to Wes: this follows the golang naming conventions. webhook.Webhook "stutters", and this type is really the central type of this package. Calling it a single letter is the norm. This could also go in the server package, in which case I'd change the name to Webhook, since service.Webhook works better. See https://blog.golang.org/package-names)