notifier

package
v0.5.4 Latest Latest
Warning

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

Go to latest
Published: Jan 13, 2026 License: MIT Imports: 34 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var TemplateFiles embed.FS

Functions

func GetClip added in v0.5.0

func GetClip(event models.Event) io.Reader

GetClip downloads a event video clip from Frigate

func GetSnapshot added in v0.4.0

func GetSnapshot(event models.Event) io.Reader

GetSnapshot downloads a snapshot from Frigate

func ParseSMTPRecipients

func ParseSMTPRecipients(recipientList string) []string

ParseSMTPRecipients splits individual email addresses from config file

func SendAlert

func SendAlert(events []models.Event)

SendAlert forwards alert information to all enabled alerting methods

func SendAppriseAPI added in v0.4.3

func SendAppriseAPI(event models.Event, snapshot io.Reader, provider notifMeta)

SendAppriseAPI forwards alert messages to Apprise API notification server

func SendDiscordMessage

func SendDiscordMessage(event models.Event, snapshot io.Reader, provider notifMeta)

SendDiscordMessage pushes alert message to Discord via webhook

func SendGotifyPush

func SendGotifyPush(event models.Event, provider notifMeta)

SendGotifyPush forwards alert messages to Gotify push notification server

func SendMatrix added in v0.4.4

func SendMatrix(event models.Event, snapshot io.Reader, provider notifMeta)

SendMatrix pushes alert message to Matrix chat via webhook

func SendMattermost added in v0.4.1

func SendMattermost(event models.Event, provider notifMeta)

SendMatterMost pushes alert message to Mattermost via webhook

func SendNtfyPush added in v0.3.1

func SendNtfyPush(event models.Event, snapshot io.Reader, provider notifMeta)

SendNtfyPush forwards alert messages to Ntfy server

func SendPushoverMessage added in v0.2.5

func SendPushoverMessage(event models.Event, snapshot io.Reader, provider notifMeta)

SendPushoverMessage sends alert message through Pushover service

func SendSMTP

func SendSMTP(event models.Event, snapshot io.Reader, provider notifMeta)

SendSMTP forwards alert data via email

func SendSignalMessage added in v0.4.1

func SendSignalMessage(event models.Event, snapshot io.Reader, provider notifMeta)

SendSignalMessage pushes alert message to Signal via webhook

func SendTelegramMessage added in v0.2.4

func SendTelegramMessage(event models.Event, snapshot io.Reader, provider notifMeta)

SendTelegramMessage sends alert through Telegram to individual users

func SendWebhook added in v0.3.0

func SendWebhook(event models.Event, provider notifMeta)

SendWebhook sends alert through HTTP POST to target webhook

Types

type AppriseAPIAttachment added in v0.4.3

type AppriseAPIAttachment struct {
	Filename string `json:"filename"`
	Base64   string `json:"base64"`
	Mimetype string `json:"mimetype"`
}

type AppriseAPIPayload added in v0.4.3

type AppriseAPIPayload struct {
	Title      string                 `json:"title"`
	Body       string                 `json:"body"`
	Tags       string                 `json:"tags,omitempty"`
	URLs       string                 `json:"urls,omitempty"`
	Type       string                 `json:"type,omitempty"`
	Format     string                 `json:"format,omitempty"`
	Attachment []AppriseAPIAttachment `json:"attachment,omitempty"`
}

type MattermostAttachment added in v0.4.1

type MattermostAttachment struct {
	ImageURL string `json:"image_url,omitempty"`
}

type MattermostPayload added in v0.4.1

type MattermostPayload struct {
	Text        string                 `json:"text"`
	Channel     string                 `json:"channel,omitempty"`
	Attachments []MattermostAttachment `json:"attachments"`
	Username    string                 `json:"username"`
	Priority    struct {
		Priority string `json:"priority,omitempty"`
	} `json:"priority,omitempty"`
}

type SignalPayload added in v0.4.1

type SignalPayload struct {
	Number      string   `json:"number"`
	Recipients  []string `json:"recipients,omitempty"`
	Message     string   `json:"message"`
	Attachments []string `json:"base64_attachments"`
}

type WebhookPayload added in v0.4.4

type WebhookPayload struct {
	Time         string   `json:"time"`
	ID           string   `json:"id"`
	Camera       string   `json:"camera"`
	Label        string   `json:"label"`
	LicensePlate string   `json:"license_plate"`
	SubLabel     string   `json:"sublabel"`
	Score        string   `json:"score"`
	Audio        string   `json:"audio"`
	CurrentZones []string `json:"current_zones"`
	EnteredZones []string `json:"entered_zones"`
	HasClip      bool     `json:"has_clip"`
	HasSnap      bool     `json:"has_snapshot"`
	Links        struct {
		Camera string `json:"camera"`
		Clip   string `json:"clip,omitempty"`
		Review string `json:"review,omitempty"`
		Snap   string `json:"snapshot,omitempty"`
	} `json:"links"`
}

Jump to

Keyboard shortcuts

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