Notification Targets

Published: December 7, 2023

What are Notification Targets?

Notification Targets are named destinations where notifications can be sent.

You create Notification Targets to receive notifications via email, Slack, AWS SNS, and webhook. You specify which Notification Targets to use when creating Notification Configurations.

Using Notification Targets

The following is an example of a Notification Target used to send notifications to a list of email addresses.

apiVersion: spyderbat/v1
kind: NotificationTarget
metadata:
  uid: notif_tgt:XXXXXXXXXXXXXXXXXXXXXX
  name: OperationsTeam
spec:
  emails:
  - [e-mail]
  - [e-mail]

This Notification Target is referenced in the following Notification Configuration:

apiVersion: spyderbat/v1
kind: NotificationConfiguration
metadata:
  createTime: 1701290311.8995287
  lastUpdated: 1701290311.8995287
  name: Spyderbat Agent Offline
  type: object
  uid: notif:XXXXXXXXXXXXXXXXXXXXXX
spec:
  ...
  target: OperationsTeam
  ...

Note: for simplicity we excluded the other spec fields in the Notification Configuration. More details on Notification Configurations are available here.

Quick Start Tutorial

To quickly get started using using Spyderbat Notifications follow our tutorial using spyctl.

How to setup Spyderbat Notifications (Spyctl CLI)

Manage Notification Targets Using Spyctl

Reference: Manage Notification Targets Using Spyctl

Types:

Emails

Email Notification Targets contain a list of email address destinations for notifications.

apiVersion: spyderbat/v1
kind: NotificationTarget
metadata:
  uid: notif_tgt:n0qp2QhdT3O3FzzVPQlYhA
  name: Example
spec:
  emails:
  - [e-mail]

Slack

Slack Notification Targets contain a single Slack Hook URL destination for notifications.

apiVersion: spyderbat/v1
kind: NotificationTarget
metadata:
  uid: notif_tgt:XXXXXXXXXXXXXXXXXXXXXX
  name: Example
spec:
  slack:
    url: https://hooks.slack.com/services/xxxxxxxxxxx/xxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx

Webhook

Webhook Notification Targets contain a single generic webhook URL destination for notifications.

apiVersion: spyderbat/v1
kind: NotificationTarget
metadata:
  uid: notif_tgt:XXXXXXXXXXXXXXXXXXXXXX
  name: Example
spec:
  webhook:
    url: https://my.webhook.example/location/of/webhook
    no_tls_validation: true

AWS SNS

AWS SNS Notification Targets contain a single AWS SNS Topic ARN destination for notifications.

apiVersion: spyderbat/v1
kind: NotificationTarget
metadata:
  uid: notif_tgt:XXXXXXXXXXXXXXXXXXXXXX
  name: Example
spec:
  sns:
    sns_topic_arn: arn:aws:sns:region:account-id:topic-name