githubhook

README

GitHub webhook

GitHub webhook HTTP Handler in Go (Golang)

Features

• HTTP Handler
• Secret validation
• JSON or form content type
• Custom payload decoding

Documentation

Overview

Package githubhook provides a HTTP Handler for GitHub webhook.

Index

• type Handler
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type RequestError
  • func (err *RequestError) Error() string

Types

type Handler

type Handler struct {
	Secret        string
	DecodePayload func(event string, rawPayload []byte) (any, error)
	Delivery      func(event string, deliveryID string, payload any)
	Error         func(err error, req *http.Request)
}

Handler is a http.Handler for GitHub webhook.

It supports both JSON and form content types.

Fields (all are optional):

• Secret is the secret defined in GitHub webhook.
• DecodePayload is called to decode payload. If it's not defined, JSON unmarshal is used.
• Delivery is called if a valid delivery is received.
• Error is called if an error happened.

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type RequestError

type RequestError struct {
	StatusCode int
	Message    string
}

RequestError represents a request error.

func (*RequestError) Error

func (err *RequestError) Error() string