Webhooks

What type of events are supported with Webhook Notifications?

Webhooks can be setup to receive one or more of the same event categories supported today with email events. The following are the event categories that can be sent through a webhook notification.

• All Events
• Session State Change
• Configuration Change
• Unexpected Severe Status
• Communication Failure
• Active Standby Connected
• Active Standby Disconnected
• Scheduled Task Completed
• Scheduled Task Failed
• Session RPO Trigger
• Logical Path Change
• Threat Detection Alert

Configuring Webhook Notifications

An Administrator or Operator with the "Manage Server" action enabled can setup webhook notifications to a webhook listener. When an event occurs, the IBM Copy Services Manager server looks up all webhook listeners that are defined on the server for that event type, and attempt to send the event to the listener. The listener or application listening must be up and running to receive the event.

To configure Webhook notifications, navigate to Settings->Alert Notifications and then click the Webhooks link in the left side navigation menu.

Then perform the following steps to setup the webhook.

1. Click the Add Webhook button
2. Enter a Name for the webhook. For example, enter the name of the application receiving the event.
3. Enter a Webhook URL. This is the URL setup on the webhook listener for receiving the event. (ex. https://hostname:8085/webhook)
4. Optionally enter a Description for the webhook.
5. Optionally enter any HTTP Headers necessary for making the call to the webhook listener. This section allows you to setup one or more headers with their associated values.
6. Under the Authentication section select one of the methods for authentication and then add additional information if applicable
   1. Choose None if the webhook listener does not require any authentication to receive the event.
   2. Choose Basic if the webhook listener requires a user ID and password for authentication to receive the event. And then enter a User Name and Password.
   3. Choose Token if the webhook listener can authenticate by using a token instead of a password.
7. Under the Event Categories section, choose which events you want the webhook listener to receive
   1. Click the All Events radio button to send all events to the webhook listener
   2. Click the Selected Events radio button to only send selected events to the webhook listener. After clicking Selected Events a table appears where you can select one or more of the event categories.
8. You can optionally Test the Webhook connectivity by clicking the Test Webhook button. The test button sends a sample json event with the event_type="webhook test".
   Note: When testing the webhook, you need to validate that the webhook event was received from the listener side. The Test button will not return a response

After configuring the webhook, the server will automatically start sending events for the selected event categories.

Click the Select Action → View Modify button to edit any of the fields before this on the webhook.

Click the Select Action → Test Webhook button to retest the webhook at any time.

What's sent in a webhook?

Webhook events are sent in json format. The type of event can be determined with the "event_type" field in the json response.

Example Test Webhook:

{
  "eventnumber": 1781718562245,
  "event_type": "webhook test",
  "createddate": 1781718562245,
  "createdtime": "Wed Jun 17 12:49:22 CDT 2026"
}

Example Threat Detection Webhook:

{ 
  "createdDate": 1779399887467, 
  "eventNumber": 1779399887467, 
  "session": "SNAP_a_pamVG2_FS5xxx", 
  "volumeGroupID": "STORAGE-VIRTUALIZE:VOLGROUP:FS5xxx:45", 
  "volumes": [ 
     { "volumeWWN": "6005076812828018A8000000000131D7", "volumeName": "test", "volumeID": "STORAGE-VIRTUALIZE:VOL:FS5xxx:44" }, 
     { "volumeWWN": "6005076812828018A8000000000131D9", "volumeName": "test2", "volumeID": "STORAGE-VIRTUALIZE:VOL:FS5xxx:62" } 
  ], 
  "createdTime": "Thu May 21 16:44:47 CDT 2026", 
  "volumeGroupName": "a_pamVG2", 
  "eventType": "THREAT_DETECTION_ALERT", 
  "deviceName": "FS5xxx", 
  "systemOccurrenceTimeMs": 1776370814000 }

Deleting a Webhook

An Administrator or Operator with the "Manage Server" action enabled can delete configured webhooks.

To delete Webhook notifications, navigate to Settings->Alert Notifications and then click the Webhooks link in the left side navigation menu.

Then perform the following steps to setup the webhook.

1. Select one of more of the webhooks listed in the table of webhooks.
2. Click the Select Action → Delete Webhook button
3. Repond to the "Are you sure you want to delete the selected webhook(s)?" prompt.