Help us shape the future of Go! Take the 2026 Go Developer Survey

webhook

package
v1.20.0 Latest Latest
Warning

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

Go to latest
Published: Jun 4, 2026 License: BSD-3-Clause Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateInput

type CreateInput struct {
	Name       string `json:"name" minLength:"1" maxLength:"255" doc:"Human-readable name for this webhook"`
	TargetType string `` /* 146-byte string literal not displayed */
	ActionType string `` /* 165-byte string literal not displayed */
	TargetID   string `json:"targetId" doc:"Container ID, project ID, or GitOps sync ID to target. Leave empty for 'updater' webhooks."`
}

CreateInput is the request body for creating a webhook.

type Created

type Created struct {
	ID         string    `json:"id" doc:"Webhook ID"`
	Name       string    `json:"name" doc:"Webhook name"`
	Token      string    `json:"token" doc:"Full webhook token — store this securely, it will not be shown again"`
	TargetType string    `json:"targetType" doc:"Target type"`
	ActionType string    `json:"actionType" doc:"Action type"`
	TargetID   string    `json:"targetId" doc:"Target resource ID"`
	CreatedAt  time.Time `json:"createdAt" doc:"Creation timestamp"`
}

Created is returned once when a webhook is first created, including the raw token.

type Summary

type Summary struct {
	ID              string     `json:"id" doc:"Webhook ID"`
	Name            string     `json:"name" doc:"Webhook name"`
	TokenPrefix     string     `json:"tokenPrefix" doc:"Masked token prefix for identification"`
	TargetType      string     `json:"targetType" doc:"Target type: 'container', 'project', 'updater', or 'gitops'"`
	ActionType      string     `json:"actionType" doc:"Action type resolved for this webhook"`
	TargetID        string     `json:"targetId" doc:"Target resource ID"`
	TargetName      string     `json:"targetName,omitempty" doc:"Resolved target resource name when available"`
	EnvironmentID   string     `json:"environmentId" doc:"Environment ID"`
	Enabled         bool       `json:"enabled" doc:"Whether the webhook is active"`
	LastTriggeredAt *time.Time `json:"lastTriggeredAt,omitempty" doc:"Timestamp of last successful trigger"`
	CreatedAt       time.Time  `json:"createdAt" doc:"Creation timestamp"`
}

Summary is returned in list responses — the token is masked.

type UpdateInput

type UpdateInput struct {
	Enabled bool `json:"enabled" doc:"Whether the webhook is active"`
}

UpdateInput is the request body for updating a webhook.

Jump to

Keyboard shortcuts

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