Back to Yugabyte Db

Yba Alert Channel Webhook Create

managed/yba-cli/docs/yba_alert_channel_webhook_create.md

2026.1.0.0-b253.2 KB
Original Source

yba alert channel webhook create

Create a webhook alert channel in YugabyteDB Anywhere

Synopsis

Create a webhook alert channel in YugabyteDB Anywhere

yba alert channel webhook create [flags]

Examples

yba alert channel webhook create --name <alert-channel-name> \
   --auth-type <webhook-auth-type> --password <password> \
   --username <webhook-username> --webhook-url <webhook-url>

Options

      --webhook-url string            [Required] Webhook webhook URL.
      --auth-type string              [Optional] Authentication type for webhook. Allowed values: none, basic, token. (default "none")
      --username string               [Optional] Username for authethicating webhook. Required if auth type is basic.
      --password string               [Optional] Password for authethicating webhook. Required if auth type is basic.
      --token-header string           [Optional] Token header for authethicating webhook. Required if auth type is token.
      --token-value string            [Optional] Token value for authethicating webhook. Required if auth type is token.
      --send-resolved-notifications   [Optional] Send resolved notifications for alert channel. (default true)
  -h, --help                          help for create

Options inherited from parent commands

  -a, --apiToken string    YugabyteDB Anywhere api token.
      --ca-cert string     CA certificate file path for secure connection to YugabyteDB Anywhere. Required when the endpoint is https and --insecure is not set.
      --config string      Full path to a specific configuration file for YBA CLI. If provided, this takes precedence over the directory specified via --directory, and the generated files are added to the same path. If not provided, the CLI will look for '.yba-cli.yaml' in the directory specified by --directory. Defaults to '$HOME/.yba-cli/.yba-cli.yaml'.
      --debug              Use debug mode, same as --logLevel debug.
      --directory string   Directory containing YBA CLI configuration and generated files. If specified, the CLI will look for a configuration file named '.yba-cli.yaml' in this directory. Defaults to '$HOME/.yba-cli/'.
      --disable-color      Disable colors in output. (default false)
  -H, --host string        YugabyteDB Anywhere Host (default "http://localhost:9000")
      --insecure           Allow insecure connections to YugabyteDB Anywhere. Value ignored for http endpoints. Defaults to false for https.
  -l, --logLevel string    Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info")
  -n, --name string        [Optional] The name of the alert channel for the operation. Use single quotes ('') to provide values with special characters. Required for create, update, describe, delete.
  -o, --output string      Select the desired output format. Allowed values: table, json, pretty. (default "table")
      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
      --wait               Wait until the task is completed, otherwise it will exit immediately. (default true)

SEE ALSO