core webhook create
qlik core webhook create
Create a new webhook
Synopsis
Creates a new webhook. User must be assigned the TenantAdmin role to create tenant level webhooks. Each user can own up to 150 webhooks per tenant; creating a webhook beyond that quota is rejected with 403.
qlik core webhook create [flags]Options
--checkCertificateRevocation If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook. --description string The reason for creating the webhook --enableCloudEventDelivery Whether this webhook delivers events as CloudEvents. On creation, the service determines the effective value from tenant feature flags and webhook origin; the supplied value is not authoritative. On PUT, omission is treated as false. When feature flags are enabled, the service may automatically enable this for exclusive Data Integration webhooks. Once enabled, it cannot be disabled; omitting it when replacing an enabled webhook therefore returns ˋ403ˋ. --enabled Whether the webhook is active and sending requests --encryptedHeaders key:string Headers that are persisted encrypted and decrypted again to be sent as normal headers in the post request (webhook delivery). In requests they are supplied as name/value pairs, but responses return only the header names as a list of strings, because the values are never disclosed. If the URL changes, these headers must be re-entered. Note: duplicate headers are not allowed and are case-insensitive. Maximum combined size: 2048 bytes (total of all encrypted header names and values). --eventTypes strings Types of events for which the webhook should trigger. Retrieve available types from ˋ/core/webhooks/event-typesˋ. -f, --file file Read request body from the specified file --filter string Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId'. Individual event-types can support additional event-specific attributes, which cannot be combined with other event-types in the same webhook. For example "com.qlik.v1.app.reload.finished" supports "data.status" with the allowed values "SUCCEEDED", "FAILED", "CANCELED" and "EXCEEDED_LIMIT". The authoritative set of filterable attributes and their allowed values for each event-type is returned in the ˋallowedFiltersˋ property of ˋGET /core/webhooks/event-typesˋ. Supported attribute operators are 'eq' and 'ne'. Supported logical operators are 'and' and 'or'. Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes. For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation. -h, --help help for create --interval int Duration in seconds to wait between retries, at least 1 (default 1) --level string Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. Allowed values: "tenant", "user" --name string (Required) The name for the webhook --origin string Indicates from where the webhook was created and its purpose Allowed values: "api", "automations", "management-console" --ownerId string The id of the user that owns the webhook, only applicable for user level webhooks -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 --secret string Shared secret used to sign the webhook delivery. Each delivery is sent with a ˋQlik-Signatureˋ header containing the hex-encoded HMAC-SHA256 of the raw request body, computed with this secret, so the receiver can verify that the payload is genuine and unmodified. The secret is stored encrypted and is never returned by the API; responses report only ˋsecretKeyAddedˋ. --url string (Required) Target URL for webhook HTTPS requests --webhook-headers key:string Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive. Maximum combined size: 2048 bytes (total of all header names and values).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