backrest/docs/content/2.docs/2.hooks.md

Hooks

Hooks in Backrest allow you to respond to various operation lifecycle events, enabling automation and monitoring of your backup operations. This document explains how to configure and use hooks effectively.

Event Types

Hooks can be triggered by the following events:

Snapshot Events

• CONDITION_SNAPSHOT_START: Triggered when a backup operation begins and will complete before the snapshot starts. The Error Handling configuration can be used to stop the backup if the command isn't successful.
• CONDITION_SNAPSHOT_END: Triggered when a backup operation completes (regardless of success/failure)
• CONDITION_SNAPSHOT_SUCCESS: Triggered when a backup operation completes successfully
• CONDITION_SNAPSHOT_ERROR: Triggered when a backup operation fails
• CONDITION_SNAPSHOT_WARNING: Triggered when a backup operation encounters non-fatal issues

Prune Events

• CONDITION_PRUNE_START: Triggered when a prune operation begins
• CONDITION_PRUNE_SUCCESS: Triggered when a prune operation completes successfully
• CONDITION_PRUNE_ERROR: Triggered when a prune operation fails

Check Events

• CONDITION_CHECK_START: Triggered when a check operation begins
• CONDITION_CHECK_SUCCESS: Triggered when a check operation completes successfully
• CONDITION_CHECK_ERROR: Triggered when a check operation fails

Forget Events

• CONDITION_FORGET_START: Triggered when a forget operation begins
• CONDITION_FORGET_SUCCESS: Triggered when a forget operation completes successfully
• CONDITION_FORGET_ERROR: Triggered when a forget operation fails

General Events

• CONDITION_ANY_ERROR: Triggered when any operation fails

Notification Services

Backrest supports multiple notification services for hook delivery:

Service	Description	Documentation
Discord	Send notifications to Discord channels	Discord Webhooks Guide
Slack	Send notifications to Slack channels	Slack Webhooks Guide
Gotify	Send notifications via Gotify server	Gotify Documentation
Shoutrrr	Multi-provider notification service	Shoutrrr Documentation
Command	Execute custom commands	See command cookbook

Error Handling

Command hooks support specific error behaviors that determine how Backrest responds to hook failures:

• ON_ERROR_IGNORE: Continue execution despite hook failure
• ON_ERROR_CANCEL: Stop the operation but don't trigger error handlers
• ON_ERROR_FATAL: Stop the operation and trigger error handler hooks

Template System

Hooks use Go templates for formatting notifications and scripts. The following variables and functions are available:

Available Variables

Variable	Type	Description	Example Usage
Event	v1.Hook_Condition	The triggering event	{{ .Event }}
Task	string	Task name	{{ .Task }}
Repo	v1.Repo	Repository information	{{ .Repo.Id }}
Plan	v1.Plan	Plan information	{{ .Plan.Id }}
SnapshotId	string	ID of associated snapshot	{{ .SnapshotId }}
SnapshotStats	restic.BackupProgressEntry	Backup operation statistics	See example below
CurTime	time.Time	Current timestamp	{{ .FormatTime .CurTime }}
Duration	time.Duration	Operation duration	{{ .FormatDuration .Duration }}
Error	string	Error message if applicable	{{ .Error }}

Helper Functions

Function	Description	Example
.Summary	Generates default event summary	{{ .Summary }}
.FormatTime	Formats timestamp	{{ .FormatTime .CurTime }}
.FormatDuration	Formats time duration	{{ .FormatDuration .Duration }}
.FormatSizeBytes	Formats byte sizes	{{ .FormatSizeBytes 1048576 }}
.ShellEscape	Escapes strings for shell usage	{{ .ShellEscape "my string" }}
.JsonMarshal	Converts value to JSON	{{ .JsonMarshal .SnapshotStats }}

Default Summary Template

Below is the implementation of the .Summary function, which you can use as a reference for creating custom templates:

Task: "{{ .Task }}" at {{ .FormatTime .CurTime }}
Event: {{ .EventName .Event }}
Repo: {{ .Repo.Id }}
Plan: {{ .Plan.Id }}
Snapshot: {{ .SnapshotId }}
{{ if .Error -}}
Failed to create snapshot: {{ .Error }}
{{ else -}}
{{ if .SnapshotStats -}}

Overview:
- Data added: {{ .FormatSizeBytes .SnapshotStats.DataAdded }}
- Total files processed: {{ .SnapshotStats.TotalFilesProcessed }}
- Total bytes processed: {{ .FormatSizeBytes .SnapshotStats.TotalBytesProcessed }}

Backup Statistics:
- Files new: {{ .SnapshotStats.FilesNew }}
- Files changed: {{ .SnapshotStats.FilesChanged }}
- Files unmodified: {{ .SnapshotStats.FilesUnmodified }}
- Dirs new: {{ .SnapshotStats.DirsNew }}
- Dirs changed: {{ .SnapshotStats.DirsChanged }}
- Dirs unmodified: {{ .SnapshotStats.DirsUnmodified }}
- Data blobs: {{ .SnapshotStats.DataBlobs }}
- Tree blobs: {{ .SnapshotStats.TreeBlobs }}
- Total duration: {{ .SnapshotStats.TotalDuration }}s
{{ end }}
{{ end }}