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 webhooks Deliveries API
version: 1.0.0
extends: openapi/qliksense-deliveries-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: 3
- target: $.paths['/api/v1/webhooks/{id}/deliveries'].get
update:
x-apievangelist-phrasing:
intent: List deliveries for a webhook
effect: read
questions:
- Which webhook deliveries failed recently?
- How far back does webhook delivery history go?
instructions:
- text: List deliveries for webhook {id}.
slots:
id: path.id
- text: Show deliveries of webhook {id} with status {status}.
slots:
id: path.id
status: query.status
- text: List webhook {id} deliveries for event type {eventType}.
slots:
id: path.id
eventType: query.eventType
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}/deliveries/{deliveryId}'].get
update:
x-apievangelist-phrasing:
intent: Get a webhook delivery
effect: read
questions:
- What payload and response did a specific webhook delivery have?
- Where can I inspect one delivery attempt?
instructions:
- text: Get delivery {deliveryId} of webhook {id}.
slots:
deliveryId: path.deliveryId
id: path.id
- text: Show details of webhook {id} delivery {deliveryId}.
slots:
id: path.id
deliveryId: path.deliveryId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}/deliveries/{deliveryId}/actions/resend'].post
update:
x-apievangelist-phrasing:
intent: Resend a webhook delivery
effect: write
questions:
- Can I retry a failed webhook delivery?
- Does resending a delivery use the same payload?
instructions:
- text: Resend delivery {deliveryId} for webhook {id}.
slots:
deliveryId: path.deliveryId
id: path.id
- text: Retry webhook {id} delivery {deliveryId}.
slots:
id: path.id
deliveryId: path.deliveryId
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.