webhook

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(webhook *portainer.Webhook) error
  • func (service *Service) DeleteWebhook(ID portainer.WebhookID) error
  • func (service *Service) UpdateWebhook(ID portainer.WebhookID, webhook *portainer.Webhook) error
  • func (service *Service) Webhook(ID portainer.WebhookID) (*portainer.Webhook, error)
  • func (service *Service) WebhookByResourceID(ID string) (*portainer.Webhook, error)
  • func (service *Service) WebhookByToken(token string) (*portainer.Webhook, error)
  • func (service *Service) Webhooks() ([]portainer.Webhook, error)

Constants

const (
	// BucketName represents the name of the bucket where this service stores data.
	BucketName = "webhooks"
)

Types

type Service

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

Service represents a service for managing webhook data.

func NewService

func NewService(connection portainer.Connection) (*Service, error)

NewService creates a new instance of a service.

func (*Service) BucketName

func (service *Service) BucketName() string

func (*Service) Create

func (service *Service) Create(webhook *portainer.Webhook) error

CreateWebhook assign an ID to a new webhook and saves it.

func (*Service) DeleteWebhook

func (service *Service) DeleteWebhook(ID portainer.WebhookID) error

DeleteWebhook deletes a webhook.

func (*Service) UpdateWebhook

func (service *Service) UpdateWebhook(ID portainer.WebhookID, webhook *portainer.Webhook) error

UpdateWebhook update a webhook.

func (*Service) Webhook

func (service *Service) Webhook(ID portainer.WebhookID) (*portainer.Webhook, error)

Webhook returns a webhook by ID.

func (*Service) WebhookByResourceID

func (service *Service) WebhookByResourceID(ID string) (*portainer.Webhook, error)

WebhookByResourceID returns a webhook by the ResourceID it is associated with.

func (*Service) WebhookByToken

func (service *Service) WebhookByToken(token string) (*portainer.Webhook, error)

WebhookByToken returns a webhook by the random token it is associated with.

func (*Service) Webhooks

func (service *Service) Webhooks() ([]portainer.Webhook, error)

Webhooks returns an array of all webhooks