Welcome to the new DOCS.vastdata.com. We've added new menus and a version selector, plus new persona and resource pages to help customers get started. Looking for a previous article? Use the docs search.

webhook modify

Prev Next

This command modifies a webhook.

Usage

webhook modify --id ID
               [--name TEXT]
               [--url URL]
               [--method {POST|PUT|PATCH|DELETE|GET}]
               [--data JSON]
               [--headers HEADERS]
               [--enable|--disable]
               [--certificate-id ID]

Required Parameters

--id ID

The ID of the webhook you want to modify.

Options

--name TEXT

A name for the webhook.

--url URL

The URL of the external application.

--method {POST|PUT|PATCH|DELETE|GET}

The HTTP method to be used when the notification is sent to the external application.

--data JSON

The data to be sent as the webhook message to the external application, in JSON format.  For example:

​​--webhook-data '"event":"$vastdata_event_name"'​

For information about variables that can be used within the JSON data, see Variables in Webhook Data.

--headers HEADERS

Custom HTTP headers to be included into the message sent to the external application. You can add as many custom headers as necessary.

Specify HEADERS as a comma-separated list of key-value pairs (key1=value1,key2=value2) where each key is the name of the header you want to add.

--enable

Enables the webhook.

--disable

Disables the webhook.

--certificate-id ID

The ID of the certificate used to secure the connection to the external application with TLS.

The certificate must be uploaded to the VMS beforehand using the certificate add --cert-type WEBHOOK command.

Example

To disable a webhook:

webhook modify --id 14 --disable