Generated by API Evangelist
Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for data-alerts alerting actions API
version: 1.0.0
extends: openapi/qliksense-alerting-actions-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/api/v1/data-alerts/actions/trigger'].post
update:
x-apievangelist-phrasing:
intent: Trigger a data alert task
effect: write
questions:
- How do I fire a data alert task manually?
- Can I trigger an alert check on demand?
instructions:
- text: Trigger data alert task {alertingTaskID}.
slots:
alertingTaskID: requestBody.alertingTaskID
- text: Run the alerting task {alertingTaskID} now.
slots:
alertingTaskID: requestBody.alertingTaskID
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/data-alerts/actions/validate'].post
update:
x-apievangelist-phrasing:
intent: Validate a data alert before creating it
effect: read
questions:
- Can I check that alert recipients are valid before creating the alert?
- What does data alert validation cover?
instructions:
- text: Validate alert {name} on app {appId} with condition {conditionId}, trigger {triggerType} and recipients {recipients}.
slots:
name: requestBody.name
appId: requestBody.appId
conditionId: requestBody.conditionId
triggerType: requestBody.triggerType
recipients: requestBody.recipients
- text: Check that recipients {recipients} are valid for alert {name} on app {appId} ({conditionId}, {triggerType}).
slots:
recipients: requestBody.recipients
name: requestBody.name
appId: requestBody.appId
conditionId: requestBody.conditionId
triggerType: requestBody.triggerType
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.