Please enable JavaScript to view this site.

SQL Backup Master Help

Navigation: Global Options

Webhooks

Scroll Prev Top Next More

SQL Backup Master can send backup completion notifications to an array of third-party services through the use of webhooks.

 

What are webhooks?

 

Webhooks are automated HTTP requests sent from applications when something happens. They are sent to a unique URL endpoint and carry an informational message (or payload).

 

SQL Backup Master can use webhooks to notify third parties about the status of backup job completions.

 

There are many services that can accept incoming webhooks, including Slack, MS Teams, PagerDuty, Discord, and many more.

 

How do I get started with webhooks?

 

First, you need to enable and configure incoming webhooks within your third-party service. The instructions for doing so will vary between third-party services, and we recommend searching their documentation for "webhook" or "incoming webhooks" for setup details.

 

We also publish a number of webhook configuration tutorials in the support section of the SQL Backup Master website. We maintain these tutorials online so that we can update them as services change and evolve.

 

The result of the webhook setup process will be a unique URL that allows you to send messages to that service.

 

How do I send webhook notifications?

 

SQL Backup Master stores webhook configuration data in a dedicated tab of the global options window. To begin, open the global Options window and navigate to the Webhooks tab. Click the Add toolbar button to create a new webhook.

 

SQL Backup Master needs the following information to send a webhook notification:

 

Name - A unique name for your webhook.

URL - The webhook URL that was provided by your third-party service.

Message body - A payload described in JSON format. *

Custom headers - Optional custom HTTP headers sent with the webhook request.

 

* SQL Backup Master includes several templates to help you compose an appropriate JSON message body for several common third-party services. For other services, please refer to their webhook documentation or contact them for support.

 

Associating a webhook with a backup job

 

Once you've created and tested your webhook, you can now associate it with one or more backup job.

 

To do so, navigate to the Notifications tab of your backup job settings. In the Send webhook notifications area, select the webhooks that should be triggered.