Managing Webhooks

Prev Next

Overview

You can create webhooks to send event information to external applications. Once defined, you can set them to be triggered by specific events in the Event Definition tab.

Creating Webhooks

  1. From the left navigation menu, select  Alarms & Events and then Webhooks.

  2. Click Create Webhook.

  3. Enter these details for the webhook:

    Field

    Description

    Webhook name

    The name of the webhook, as it will appear in the list in the Webhooks tab.

    Webhook Method

    Select from the dropdown list the HTTP method to be used when the notification is sent to the external application.

    Webhook URL

    The URL of the external application.

  4. In the Webhook Data pane, enter the data block to be sent as the webhook message to the external application, in JSON format. Alternatively, click Upload JSON to browse and upload a file with the JSON data block.

    Note

    The Events panel shows a list of variables, and their meanings, that can be included in the JSON data block, to indicate specific details for the event, such as the name, time, duration, etc.

  5. In the Certificate pane, optionally select the certificate to be used, from the list.

  6. Click Save. The new webhook appears in the list in the Webhooks tab.

  7. Right-click on the webhook in the list, and click Activate to enable it.

Examples of Webhook Data

This JSON data block:

{
  "event_name": "$vastdata_event_name",
  "object_name": "$vastdata_object_name",
  "event_type": "$vastdata_event_type"
}

results in this, when the variables are substituted with actual event information:

{
  "event_name": "VIEW_CREATE", 
  "object_name": "/c", 
  "event_type": "OBJECT_CREATED"
}

Modifying or Deleting Webhooks

  1. From the left navigation menu, select  Alarms & Events and then Webhooks.

  2. Right-click on the webhook to modify or delete, then select Edit to modify it, or Delete to delete it. If you are editing the webhook, make the necessary changes and then click Save.

    Note

    You cannot delete a webhook that is associated with Event Definitions.

Listing Webhooks

  • From the left navigation menu, select  Alarms & Events and then Webhooks.  A list of all the webhooks that have been defined is shown. Right-click on a webhook to open a menu with actions to view details for the webhook, modify it, remove it, enable it, or disable it.

Activating or Deactivating Webhooks

  • From the left navigation menu, select  Alarms & Events and then Webhooks . A list of all the webhooks that have been defined is shown. Right-click on a webhook and select Activate to  enable it, or Deactivate to disable it.

    Note

    You cannot deactivate a webhook that is associated with one or more event definitions.