.Task Hook variable includes unexpected prefix text

[Morbus7]

Hi,

According to the documentation, the .Task variable is expected to be the name of the task (plan?). However, I noticed that it also includes the leading text "backup for plan " — for example:

Task: "backup for plan daily-backup"

This adds extra complexity when using the value in automated reports or integrations, especially when formatting output in other languages or generating user-facing notifications. One has to manually strip out the prefix to get the actual task name.

Is this intentional? If so, it would be helpful to clarify this behavior in the documentation. If not, perhaps the variable could be adjusted to return only the task name itself.

It’s not a big issue — I’ve worked around it — but it would make the .Task value much easier to use directly if it only contained the core identifier.

Thanks for a great tool!

[garethgeorge]

Hey -- if I understand correctly you're trying to find the ID of the Plan or the name of the Repo that the task is running under?

The structure of hookvars is

backrest/internal/orchestrator/tasks/hookvars.go

Lines 18 to 28 in 85ec74f

	type HookVars struct {
	Task string // the name of the task that triggered the hook.
	Event v1.Hook_Condition // the event that triggered the hook.
	Repo *v1.Repo // the v1.Repo that triggered the hook.
	Plan *v1.Plan // the v1.Plan that triggered the hook.
	SnapshotId string // the snapshot ID that triggered the hook.
	SnapshotStats *restic.BackupProgressEntry // the summary of the backup operation.
	CurTime time.Time // the current time as time.Time
	Duration time.Duration // the duration of the operation that triggered the hook.
	Error string // the error that caused the hook to run as a string.
	}

You can access the repo as {{ .Repo.Id }} or the plan as {{ .Plan.Id }}.

[Morbus7]

I was building a status monitor within HomeAssistant. It shows latest run times, number of files added, etc. Everything works fine.
I just noticed that the title for the backup jobs was getting wrong, as it includes some additional unexpected text.

Lets say I have a plan called "vmstore-to-azure"

Im using the .Task variable. and it returns this
backup for plan vmstore-to-azure
I expected it to include only the name of the task (vmstore-to-azure) and not the text "backup for plan"

But when thinking of it, I dont see "Task" mentioned anywhere else, so perhaps I am misunderstanding the meaning of that variable.
Is there a variable that returns the displayname of Plans and Repos?

I am using this as the HOOK command
curl -X POST http://10.0.10.12:9123/api/webhook/backrest_backup_report \ -H "Content-Type: application/x-www-form-urlencoded" \ --data-urlencode "report=Task: \"{{ .Task }}\" Time: {{ .FormatTime .CurTime }} Total bytes processed: {{ .FormatSizeBytes .SnapshotStats.TotalBytesProcessed }} Files added: {{ .SnapshotStats.FilesNew }} Data added: {{ .FormatSizeBytes .SnapshotStats.DataAdded }} Duration: {{ .SnapshotStats.TotalDuration }}s"

The data I receive in the other end is this:

[garethgeorge]

What you are thinking of as the task is the name of the plan, the variable you're looking for is .Plan.Id :)