webhook

package
v0.0.0-...-e14edc6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 5, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package webhook implements a Pilot notification plugin that sends events as JSON HTTP POST requests to a user-configured URL.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	URL     string            `json:"url"`
	Method  string            `json:"method,omitempty"`  // default: POST
	Headers map[string]string `json:"headers,omitempty"` // extra request headers
}

Config holds the user-supplied settings for a webhook notifier.

type Notifier

type Notifier struct {
	// contains filtered or unexported fields
}

Notifier is a webhook notifier plugin instance.

func New

func New(cfg Config) *Notifier

New creates a new Notifier from the given config.

func (*Notifier) Name

func (n *Notifier) Name() string

func (*Notifier) Notify

func (n *Notifier) Notify(ctx context.Context, event plugin.NotificationEvent) error

Notify sends the event as a JSON payload to the configured URL.

func (*Notifier) Test

func (n *Notifier) Test(ctx context.Context) error

Test sends a test event to verify the webhook is reachable.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL