Skip to content

core webhook patch

qlik core webhook patch

Update selected webhook properties

Synopsis

Updates one or more individual properties of a webhook using a JSON Patch document, leaving all other properties unchanged. The patch is applied to the stored webhook and the result is validated as a whole, so a patch that produces an invalid webhook is rejected. When /url is changed on a webhook that has encrypted headers, every existing encrypted header must also be replaced or removed in the same patch, otherwise the request is rejected with 400. Changing read-only properties is rejected with 409, and changing /ownerId requires permission to transfer ownership.

qlik core webhook patch <webhookId> [flags]

Options

-f, --file file Read request body from the specified file
-h, --help help for patch
--interval int Duration in seconds to wait between retries, at least 1 (default 1)
--op string The operation to be performed
Allowed values: "add", "remove", "replace"
--path string The path of the webhook property to patch. Only writable properties can be patched; read-only properties such as ˋ/idˋ, ˋ/createdAtˋ, ˋ/createdByUserIdˋ and ˋ/originˋ are rejected. Individual members of ˋ/headersˋ and ˋ/encryptedHeadersˋ can also be addressed directly, for example ˋ/encryptedHeaders/myHeaderˋ.
Allowed values: "/name", "/description", "/url", "/eventTypes", "/headers", "/enabled", "/secret", "/encryptedHeaders", "/enableCloudEventDelivery", "/filter", "/level", "/ownerId", "/checkCertificateRevocation"
-q, --quiet Return only IDs from the command
--raw Return original response from server without any processing
--retry int Number of retries to do before failing, max 10
--value bool|int|unknown|string The value to be used for this operation. The type must match the patched property, for example an array of event-type names for ˋ/eventTypesˋ or an object of header name/value pairs for ˋ/headersˋ. Not used by the ˋremoveˋ operation.

Options inherited from parent commands

-c, --config string path/to/config.yml where parameters can be set instead of on the command line
--context string Name of the context used when connecting to Qlik Associative Engine
--headers stringToString HTTP headers to use when connecting to Qlik Associative Engine (default [])
--insecure Allow connecting to hosts with self-signed certificates
--json Returns output in JSON format, if possible. Disables verbose and traffic output
-s, --server string URL to Qlik Cloud or directly to a Qlik Associative Engine
--server-type string The type of server you are using: cloud, Windows (Enterprise on Windows) or engine
-v, --verbose Log extra information
Was this page helpful?