SqlBackupAndFTP can send notifications to Incoming Webhook. To configure it, you need a webhook URL and a request body template that can include job data.

What You Need to Fill In

1. In the Name field, enter a clear channel name. For example, the name of the service you are calling.
2. In the Webhook URL field, paste the full webhook address that should accept the POST request.
3. In the Content-Type field, specify the request body format. Usually this is application/json.
4. In the Body field, enter the request body template.
5. If needed, add variables to the Body in the *%%name%%* format.
6. Select when notifications should be sent: On Success, On Failure, or both.
7. If necessary, limit sending by Backup types.
8. Click Test to send a test webhook.

How Sending Works

When a notification is sent, SqlBackupAndFTP takes the text from the Body field, substitutes the variable values, and sends the result to the Webhook URL through an HTTP POST request. The request body is sent in UTF-8 using the specified Content-Type.

Supported Variables

Use variables in the *%%name%%* format.

• *%%is_success%%* – True or False depending on the job result.
• *%%job_type_label%%* – the job type.
• *%%job_name%%* – the job name.
• *%%server%%* – the server or computer name.
• *%%started_at%%* – the job start time.
• *%%finished_at%%* – the job finish time.
• *%%time_zone_label%%* – the local time zone label.
• *%%backup_type%%* – the backup type.
• *%%archive_size%%* – the archive size.
• *%%next_start_at%%* – the time of the next run.
• *%%next_backup_type%%* – the type of the next backup.
• *%%objects_summary%%* – brief information about the job objects.
• *%%first_error%%* – the first error or the main error line.
• *%%error_lines%%* – the list of error lines combined into a single text.

Body Example

{
  "jobName": "*%%job_name%%*",
  "server": "*%%server%%*",
  "isSuccess": "*%%is_success%%*",
  "backupType": "*%%backup_type%%*",
  "firstError": "*%%first_error%%*"
}

Important Notes

• Webhook URL is required and must be a full address starting with http or https.
• Body is required.
• If the template contains an unknown variable, it will be replaced with an empty string.
• Before saving, make sure the receiving side expects exactly the Content-Type and Body format that you specify.