Configuring Webhooks for Real-time Dashboard Schedule Alerts
Bold BI allows you to set up a webhook to trigger or notify the other application using dashboard schedule. This feature enables seamless integration with other applications and ensures that you receive timely notifications about your dashboard schedule exports.
Managing Webhooks
Webhooks are user-defined HTTP callbacks that deliver real-time data to other applications when specific events occur. Bold BI supports webhook notifications for Time-Driven and Alert-Driven dashboard exports.
To create and manage webhooks in Bold BI application refer to the link.
Payload Details for Dashboard Schedule
| Payload Data | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Dashboard Id | The ID of the dashboard selected for export | ||||||||
| Dashboard Name | The name of the dashboard selected for export | ||||||||
| Export Format | The dashboard schedule export format. For example: pdf | ||||||||
| File Content | File content of the dashboard | ||||||||
| File Extension | The extension of the export file | ||||||||
| Message | Mail content of dashboard export | ||||||||
| Schedule Id | Id of the export schedule | ||||||||
| Schedule Name | Name of the export schedule | ||||||||
| Alert Info |
|
How to configure the Dashboard Schedule with Webhook
To set up a dashboard schedule with a webhook, follow these steps:
- Log in to the Bold BI application with user who have access to create dashboard schedule. Then, navigate to the Schedules page.
Sample URL: {domain_name}/bi/site/{site_identifier}/schedules - Click on the "Create Schedule" button. The dialog box will open to configure all parameters, and then you can create a new schedule.
- Choose the dashboard you wish to schedule, then fill the necessary schedule details,
- If enabled Data Alerts in the previous form, then apply the appropriate condition. Then, proceed by clicking the Next button. If necessary, you can modify the mail body and subject as well in the next dialog.
- Configure the desired recurrence intervals and click Next,
Choose the "Webhook" option in the "Other Destination" section.
- Select the webhook that you previously created from the dropdown menu and proceed to schedule the dashboard.
Now, whenever the dashboard schedule is triggered, Bold BI will send an alert to your application. For more information on webhooks and dashboard schedules in Bold BI, please refer to the following resources:
