notification

Documentation

Index

• type AmazonEventBrigeNotification
• type BigPandaNotification
• type EmailNotification
• type JiraNotification
• type Notification
  • func (n *Notification) MarshalJSON() ([]byte, error)
  • func (n *Notification) UnmarshalJSON(data []byte) error
• type Office365Notification
• type OpsgenieNotification
• type PagerDutyNotification
• type ServiceNowNotification
• type SlackNotification
• type TeamEmailNotification
• type TeamNotification
• type VictorOpsNotification
• type WebhookNotification
• type XMattersNotification

Types

type AmazonEventBrigeNotification

type AmazonEventBrigeNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For a Amazon EventBrige notification, this is always \"AmazonEventBrige\".
	Type string `json:"type"`
	// The SignalFx ID of the integration profile for Amazon EventBrige. Use the Integrations API to get the credential ID for your AmazonEventBrige integration.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via AWS EventBrige

type BigPandaNotification

type BigPandaNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For a BigPanda notification, this is always  \"BigPanda\".
	Type string `json:"type"`
	// The SignalFx ID of the integration profile for BigPanda. Use the Integrations API to get the credential ID for your BigPanda integration.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via BigPanda

type EmailNotification

type EmailNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For an email notification, this is always \"Email\".
	Type string `json:"type"`
	// The destination address for the notification email. SignalFx doesn't validate this address, so you must ensure it's correct before you use it. SignalFx may not store invalid values, and it may try to  send notification email that doesn't have an address. In either case, the notification won't be delivered.
	Email string `json:"email"`
}

Notification properties for an alert sent via email

type JiraNotification

type JiraNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For a Jira notification, this is always  \"Jira\".
	Type string `json:"type"`
	// The SignalFx ID of the integration profile for Jira. Use the Integrations API to get the credential ID for your Jira integration.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via Jira

type Notification

type Notification struct {
	Type  string
	Value interface{}
}

Notification properties for an alert sent to the team

func (*Notification) MarshalJSON

func (n *Notification) MarshalJSON() ([]byte, error)

MarshalJSON unwraps the `Value` and makes this marshal in the way we expect.

func (*Notification) UnmarshalJSON

func (n *Notification) UnmarshalJSON(data []byte) error

type Office365Notification

type Office365Notification struct {
	// Tells SignalFx which external system it should use to send the notification. For an Office365 notification, this is always  \"Office365\".
	Type string `json:"type"`
	// The SignalFx ID of the integration profile for Office365. Use the Integrations API to get the credential ID for your Office365 integration.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via Office365

type OpsgenieNotification

type OpsgenieNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For an Opsgenie notification, this is always \"Opsgenie\".
	Type string `json:"type"`
	// Opsgenie-supplied credential ID that SignalFx uses to authenticate the notification with the Opsgenie system. Get this value from your Opsgenie account settings.
	CredentialId string `json:"credentialId"`
	// Name of an Opsgenie entity to which SignalFx assigns the alert<br> **NOTE:**<br> Specify either `responderName` or `responderId`, but not both.
	ResponderName string `json:"responderName,omitempty"`
	// ID of an Opsgenie entity to which SignalFx assigns the alert<br> **NOTE:**<br> Specify either `responderId` or `responderName`, but not both.
	ResponderId string `json:"responderId,omitempty"`
	// Type of the Opsgenie entity specified by `responderName`. The only valid value is `\"Team\"`.
	ResponderType string `json:"responderType,omitempty"`
}

Notification properties for an alert sent via Opsgenie.<br> **NOTE:**<br> When you specify Opsgenie as the notification service type, use either the `responderId` or `responderName` request body property, but don't use both.

type PagerDutyNotification

type PagerDutyNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For a PagerDuty notification, this is always \"PagerDuty\".
	Type string `json:"type"`
	// PagerDuty-supplied credential ID that SignalFx uses to authenticate the notification with the PagerDuty system. Get this value from your PagerDuty account settings.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via PagerDuty

type ServiceNowNotification

type ServiceNowNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For a ServiceNow notification, this is always \"ServiceNow\".
	Type string `json:"type"`
	// ServiceNow-supplied credential ID that SignalFx uses to authenticate the notification with the ServiceNow system. Get this value from your ServiceNow account settings.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via ServiceNow

type SlackNotification

type SlackNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For a Slack notification, this is always \"Slack\".
	Type string `json:"type"`
	// The name of the Slack channel in which to display the notification. Omit the leading \"#\" symbol. For example, specify \"#critical-notifications\" as \"critical-notifications\".
	Channel string `json:"channel"`
	// Slack-supplied credential ID that SignalFx uses to authenticate the notification with the Slack system. Get this value from your Slack account settings.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via Slack

type TeamEmailNotification

type TeamEmailNotification struct {
	// Tells SignalFx which system it should use to send the notification. For an TeamEmail notification, this is always \"TeamEmail\".
	Type string `json:"type"`
	// The SignalFx-assigned ID of the team that should receive the notification.
	Team string `json:"team,omitempty"`
}

Properties for a notification sent to the team via email

type TeamNotification

type TeamNotification struct {
	// Tells SignalFx which system it should use to send the notification. For an TeamEmail notification, this is always \"TeamEmail\".
	Type string `json:"type"`
	// The SignalFx-assigned ID of the team that should receive the notification.
	Team string `json:"team,omitempty"`
}

Properties for a notification sent to the team via email

type VictorOpsNotification

type VictorOpsNotification struct {
	// Tells SignalFx which system to use to send the notification. For a VictorOps notification, this is always \"VictorOps\".
	Type string `json:"type"`
	// VictorOps-supplied credential ID that SignalFx uses to authenticate the notification with the VictorOps system. Get this value from your VictorOps account settings.
	CredentialId string `json:"credentialId"`
	// Indicates the routing key used to determine how to process the  notification message. This key specifies where the notification is posted and how related alerts are escalated. For more information see the  [VictorOps knowlegebase](https://help.victorops.com/knowledge-base/routing-keys/).
	RoutingKey string `json:"routingKey"`
}

Notification properties for an alert sent via VictorOps

type WebhookNotification

type WebhookNotification struct {
	// Tells SignalFx which system to use to send the notification. For a Webhook notification, this is always \"Webhook\".
	Type string `json:"type"`
	// Authentication credentials for the system that the Webhook url  connects to. You usually find this value in the account settings for the system that the Webhook connects to.
	CredentialId string `json:"credentialId,omitempty"`
	// A secret value that identifies the Webhook integration to use when  sending notifications. This value also indicates that the  notification has permission to use the integration.  If `credentialId` is set, this property is ignored.
	Secret string `json:"secret,omitempty"`
	// The URL of a Webhook integration. You must provide the mechanism for processing notifications sent to the URL and routing them to the proper chat or incident management system. If `credentialId` is set, this property is ignored.
	Url string `json:"url,omitempty"`
}

Notification properties for an alert sent via a Webhook

type XMattersNotification

type XMattersNotification struct {
	// Tells SignalFx which external system it should use to send the notification. For an xMatters notification, this is always  \"XMatters\" (with a capital \"X\").
	Type string `json:"type"`
	// xMatters-supplied credential ID that SignalFx uses to authenticate the notification with the xMatters system. Get this value from your xMatters account settings.
	CredentialId string `json:"credentialId"`
}

Notification properties for an alert sent via xMatters