Categorygithub.com/whosonfirst/go-webhookd-pubsub
modulepackage
1.1.3
Repository: https://github.com/whosonfirst/go-webhookd-pubsub.git
Documentation: pkg.go.dev

# README

go-webhookd-pubsub

Go package to implement the whosonfirst/go-webhookd interfaces for dispatching webhooks messages to a Redis PubSub channel.

Documentation

Go Reference

Before you begin please read the go-webhookd documentation for an overview of concepts and principles.

Usage

import (
	_ "github.com/go-webhookd-pubsub"
)

Dispatchers

PubSub

The PubSub dispatcher will send messages to a Redis PubSub channel. It is defined as a URI string in the form of:

pubsub://{REDIS_HOST}:{REDIS_PORT}/{REDIS_CHANNEL}

Properties

NameValueDescriptionRequired
redis_hoststringThe Redis host to publish toyes
redis_portintThe Redis port to publish toyes
redis_channlestringThe name of the Redis channel to publish toyes

See also

# Packages

package cmd provides command line tools for working with go-webhookd-pubsub services.

# Functions

NewPubSubDispatcher returns a new `PubSubDispatcher` instance configured by 'uri' in the form of: pubsub://{REDIS_HOST}:{REDIS_PORT}/{REDIS_CHANNEL}.

# Structs

PubSubDispatcher implements the `webhookd.WebhookDispatcher` interface for dispatching messages to a Redis PubSub channel.