teamsworkflows

Documentation

Index

• type AdaptiveCardBody
• type AlertProvider
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) IsValid() bool
  • func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, ...) error
• type CardBody
• type Fact
• type FactSetBody
• type Override

Types

type AdaptiveCardBody

type AdaptiveCardBody struct {
	Type    string     `json:"type"`
	Version string     `json:"version"`
	Body    []CardBody `json:"body"`
}

AdaptiveCardBody represents the structure of an Adaptive Card

type AlertProvider

type AlertProvider struct {
	WebhookURL string `yaml:"webhook-url"`

	// DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type
	DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"`

	// Overrides is a list of Override that may be prioritized over the default configuration
	Overrides []Override `yaml:"overrides,omitempty"`

	// Title is the title of the message that will be sent
	Title string `yaml:"title,omitempty"`
}

AlertProvider is the configuration necessary for sending an alert using Teams

func (*AlertProvider) GetDefaultAlert

func (provider *AlertProvider) GetDefaultAlert() *alert.Alert

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) IsValid

func (provider *AlertProvider) IsValid() bool

IsValid returns whether the provider's configuration is valid

func (*AlertProvider) Send

func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error

Send an alert using the provider

type CardBody

type CardBody struct {
	Type      string       `json:"type"`
	Text      string       `json:"text,omitempty"`
	Wrap      bool         `json:"wrap"`
	Separator bool         `json:"separator,omitempty"`
	Size      string       `json:"size,omitempty"`
	Weight    string       `json:"weight,omitempty"`
	Items     []CardBody   `json:"items,omitempty"`
	Facts     []Fact       `json:"facts,omitempty"`
	FactSet   *FactSetBody `json:"factSet,omitempty"`
}

CardBody represents the body of the Adaptive Card

type Fact

type Fact struct {
	Title string `json:"title"`
	Value string `json:"value"`
}

Fact represents an individual fact in the FactSet

type FactSetBody

type FactSetBody struct {
	Type  string `json:"type"`
	Facts []Fact `json:"facts"`
}

FactSetBody represents the FactSet in the Adaptive Card

type Override

type Override struct {
	Group      string `yaml:"group"`
	WebhookURL string `yaml:"webhook-url"`
}

Override is a case under which the default integration is overridden