Type Alias WebhookBase

type WebhookBase = {
    checkCertificateRevocation?: boolean;
    createdAt?: string;
    createdByUserId?: string;
    description?: string;
    disabledReason?: string;
    disabledReasonCode?: string;
    enableCloudEventDelivery?: boolean;
    enabled?: boolean;
    encryptedHeaders?: Record<string, string>;
    eventTypes?: string[];
    filter?: string;
    headers?: Record<string, string>;
    id?: string;
    level?: "tenant" | "user";
    name: string;
    ownerId?: string;
    secret?: string;
    updatedAt?: string;
    updatedByUserId?: string;
    url: string;
}
Index

Properties

checkCertificateRevocation? createdAt? createdByUserId? description? disabledReason? disabledReasonCode? enableCloudEventDelivery? enabled? encryptedHeaders? eventTypes? filter? headers? id? level? name ownerId? secret? updatedAt? updatedByUserId? url

Properties

checkCertificateRevocation?: boolean

If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook.

createdAt?: string

The UTC timestamp when the webhook was created.

createdByUserId?: string

The id of the user that created the webhook.

description?: string

The reason for creating the webhook.

disabledReason?: string

The reason for the webhook to be disabled.

disabledReasonCode?: string

The unique code for the reason.

enableCloudEventDelivery?: boolean

If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled.

enabled?: boolean

Whether the webhook is active and sending requests.

encryptedHeaders?: Record<string, string>

These headers are persisted encrypted and decrypted to be sent as normal headers in post request (webhook delivery), in case of URL change these headers will need to be re-entered. Note: duplicate headers are not allowed and are case-insensitive.

eventTypes?: string[]

Types of events for which the webhook should trigger. Retrieve available types from /v1/webhooks/event-types.

filter?: string

Filter that should match for a webhook to be triggered. Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other 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.

headers?: Record<string, string>

Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive.

id?: string

The webhook's unique identifier.

level?: "tenant" | "user"

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.

name: string

The name for the webhook.

ownerId?: string

The id of the user that owns the webhook, only applicable for user level webhooks.

secret?: string

String used as secret for calculating HMAC hash sent as header.

updatedAt?: string

The UTC timestamp when the webhook was last updated.

updatedByUserId?: string

The id of the user that last updated the webhook.

url: string

Target URL for webhook HTTPS requests.

Settings

Member Visibility

On This Page

Properties