Webhook Notification Template

The Alerts webhook may require additional configuration to send the alerts. The JSON body is used in the alert webhook notification. When configuring the alert with webhook, you need to modify the JSON body format preferred to your webhook application.

The following are the example JSON templates:

Default JSON Template:

The default JSON template is used for many third-party applications that supports webhook. You can modify the default template and the token values as required.

Example

{
    "Alert": "<ALERT NAME>",
    "Type": "<ALERT CATEGORY - ALERT TYPE>",
    "Detected Criteria": "<DETECTED CRITERIA>",
    "Detected Time": "<TIME>",
    "CommCell": "<COMMCELL NAME>",
    "User": "<USER NAME>",
    "Job ID": "<JOB ID>",
    "Status": "<STATUS>",
    "Client": "<CLIENT DISPLAY NAME>",
    "Agent Type": "<AGENT TYPE NAME>",
    "Instance": "<INSTANCE NAME>",
    "Backup Set": "<BACKUPSET NAME>",
    "Subclient": "<SUBCLIENT NAME>",
    "Backup Level": "<LEVEL>",
    "Storage Policies Used": "<STORAGE POLICIES USED>",
    "Virtual Machine Name": "<VIRTUAL MACHINE NAME>",
    "Virtual Machine Host Name": "<VIRTUAL MACHINE HOST NAME>",
    "Virtual Machine Backup Status": "<VM STATUS>",
    "Failure reason for Virtual Machine Backup": "<VM FAILURE REASON>",
    "Start Time": "<START TIME>",
    "Scheduled Time": "<SCHEDULE TIME>",
    "End Time": "<END TIME>",
    "Error Code": "<ERR CODE>",
    "Failure Reason": "<FAILURE REASON>",
    "Protected Counts": "<PROTECTED COUNT>",
    "Failed Counts": "<FAILED COUNT>",
    "Additional Information ": "<ADDITIONAL VM INFO>"
}

Microsoft Teams Template

Microsoft Teams allows webhook to receive alerts, events, and audit trail information. For more information about configuring webhook on MS Teams, see Create Incoming Webhooks.

Example

{
  "summary": "<ALERT CATEGORY - ALERT TYPE>",
  "themeColor": "0078D7",
  "title": "<ALERT NAME>",
  "sections": [
    {
      "facts": [
        {
          "name": "Detected Criteria",
          "value": "<DETECTED CRITERIA>"
        },
        {
          "name": "Detected Time",
          "value": "<TIME>"
        },
        {
          "name": "CommCell",
          "value": "<COMMCELL NAME>"
        },
        {
          "name": "User",
          "value": "<USER NAME>"
        },
        {
          "name": "Job ID",
          "value": "<JOB ID>"
        },
        {
          "name": "Status",
          "value": "<STATUS>"
        },
        {
          "name": "Client",
          "value": "<CLIENT DISPLAY NAME>"
        },
        {
          "name": "Agent Type",
          "value": "<AGENT TYPE NAME>"
        },
        {
          "name": "Instance",
          "value": "<INSTANCE NAME>"
        },
        {
          "name": "Backup Set",
          "value": "<BACKUPSET NAME>"
        },
        {
          "name": "Subclient",
          "value": "<SUBCLIENT NAME>"
        },
        {
          "name": "Start Time",
          "value": "<START TIME>"
        },
        {
          "name": "Company name",
          "value": "<ORGANIZATION NAME>"
        }
      ],
      "text": "<ALERT CATEGORY - ALERT TYPE>"
    }
  ]
}

Slack Template

You can configure Slack to receive webhook alerts from Commvault. For more information, see Getting Started with Incoming Webhooks.

Example

{
    "text": "<ALERT CATEGORY - ALERT TYPE>",
    "blocks": [
        {
            "type": "section",
            "text": {
                "type": "plain_text",
                "text": "<ALERT NAME>"
            }
        },
        {
            "type": "section",
            "text": {
                "type": "mrkdwn",
                "text": "<ALERT CATEGORY - ALERT TYPE>"
            }
        },
        {
            "type": "section",
            "block_id": "section789",
            "fields": [
                {
                    "type": "mrkdwn",
                    "text": "Detected Criteria: <DETECTED CRITERIA> \n"
                },
                {
                    "type": "mrkdwn",
                    "text": "Detected Time: <TIME> \n"
                },
                {
                    "type": "mrkdwn",
                    "text": "Client name: <CLIENT DISPLAY NAME> \n"
                },
                {
                    "type": "mrkdwn",
                    "text": "Agent Type: <AGENT TYPE NAME> \n"
                },
                {
                    "type": "mrkdwn",
                    "text": "Job ID: <JOB ID> \n"
                },
                {
                    "type": "mrkdwn",
                    "text": "Instance: <INSTANCE NAME> \n"
                },
                {
                    "type": "mrkdwn",
                    "text": "Backup Set: <BACKUPSET NAME> \n"
                },
                {
                    "type": "mrkdwn",
                    "text": "Company name: <ORGANIZATION NAME> \n"
                }
            ]
        }
    ]
}

Splunk Template

Commvault can send alerts and events to Splunk using HTTP Event Collector (HEC). For more information, see Set up and use HTTP Event Collector in Splunk Web.

Example

{ "Alert": "<ALERT NAME>", "Type": "<ALERT CATEGORY - ALERT TYPE>", "Detected Criteria": "<DETECTED CRITERIA>", "Detected Time": "<TIME>", "CommCell": "<COMMCELL NAME>", "User": "<USER NAME>", "Job ID": "<JOB ID>", "Status": "<STATUS>", "Start Time": "<START TIME>", "Scheduled Time": "<SCHEDULE TIME>", "End Time": "<END TIME>", "Error Code": "<ERR CODE>", "Failure Reason": "<FAILURE REASON>", "Company name": "<ORGANIZATION NAME>", "Client": "<CLIENT DISPLAY NAME>"}