webhook

Documentation

Index

• Constants
• func Handler(plugin Plugin, secret string, logs logger.Logger) http.Handler
• type Plugin
  • func Client(endpoint, secret string, skipverify bool) Plugin
• type Request

Constants

const (
	EventBuild = "build"
	EventRepo  = "repo"
	EventUser  = "user"
)

Webhook event types.

const (
	ActionCreated  = "created"
	ActionUpdated  = "updated"
	ActionDeleted  = "deleted"
	ActionEnabled  = "enabled"
	ActionDisabled = "disabled"
)

Webhook action types.

const V1 = "application/vnd.drone.webhook.v1+json"

V1 is version 1 of the admission API

Functions

func Handler

func Handler(plugin Plugin, secret string, logs logger.Logger) http.Handler

Handler returns a http.Handler that accepts JSON-encoded HTTP requests for a webhook, invokes the underlying webhook plugin, and writes the JSON-encoded data to the HTTP response.

The handler verifies the authenticity of the HTTP request using the http-signature, and returns a http.StatusBadRequest Bad Request if the signature is missing or invalid.

The handler can optionally encrypt the response body using aesgcm if the HTTP request includes the Accept-Encoding header set to aesgcm.

Types

type Plugin

type Plugin interface {
	Deliver(context.Context, *Request) error
}

Plugin responds to a webhook request.

func Client

func Client(endpoint, secret string, skipverify bool) Plugin

Client returns a new plugin client.

type Request

type Request struct {
	Event  string        `json:"event"`
	Action string        `json:"action"`
	User   *drone.User   `json:"user,omitempty"`
	Repo   *drone.Repo   `json:"repo,omitempty"`
	Build  *drone.Build  `json:"build,omitempty"`
	System *drone.System `json:"system,omitempty"`
}

Request defines a webhook request.