Configuration Automation - Ping CLI

pingcli pingone webhooks apply

Create or update a webhook

Synopsis

Idempotently create or update a webhook looked up by the "name" field in the JSON body within the supplied --environment-id. If no webhook with the given name exists it is created; if exactly one exists it is updated; if more than one exists the command fails.

pingcli pingone webhooks apply [flags]

Examples

  # Create or update a webhook (body supplies name, enabled, filterOptions, etc.)
  pingcli pingone webhooks apply --environment-id <env-id> --from-file webhook.json

  # Create or update a webhook from a JSON file, overriding the enabled state
  pingcli pingone webhooks apply --environment-id <env-id> --from-file webhook.json --enabled=false

  # Read body from stdin
  pingcli pingone webhooks apply --environment-id <env-id> --from-file - < webhook.json

Options

  -e, --environment-id string                The PingOne environment ID
  -h, --help                                 help for apply
  -f, --from-file string                     Path to a JSON file containing the request body, or "-" to read from stdin.
  -w, --webhook-id string                    The webhook (subscription) ID
      --enabled                              Whether the webhook subscription is active
      --format string                        The payload format for webhook events (e.g. ACTIVITY, SPLUNK, NEWRELIC)
      --name string                          The webhook subscription name
      --tls-client-auth-key-pair-id string   ID of the key to use for outbound mutual TLS authentication
      --verify-tls-certificates              Whether TLS certificates are verified when delivering events

Options inherited from parent commands

  -C, --config string           The relative or full path to a custom Ping CLI configuration file. (default $HOME/.pingcli/config.yaml)
  -D, --detailed-exitcode       Enable detailed exit code output. (default false) 0 - pingcli command succeeded with no errors or warnings. 1 - pingcli command failed with errors. 2 - pingcli command succeeded with warnings.
  -O, --output-format string    Specify the console output format. (default text) Options are: json, ndjson, ndjson-typed, ndjson-wrapped, text.
  -P, --profile string          The name of a configuration profile to use.
      --debug                   Enable debug output for error messages, including stack traces and transaction IDs. (default false)
      --log-file string         Write logs to a file at the given path. File logging is disabled when not set.
      --log-file-level string   Set the file log level. Options are: DEBUG, INFO, WARN, ERROR. (default DEBUG)
      --log-level string        Set the console log level. Options are: DEBUG, INFO, WARN, ERROR. (default WARN)
      --no-color                Disable text output in color. (default false)
      --query string            JMESPath expression to filter JSON output. Requires -O json, ndjson, ndjson-typed, or ndjson-wrapped. Example: --query 'data[?enabled].name'

More information