Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for App Push Mobile Client Engagements API

2 actions 2 updates phrasing extends openapi/listrak-app-push-mobile-client-engagements-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Listrak's API. It is a proposal applied on top of the contract, not a document Listrak publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/device/{deviceUid}/engagement'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Push Mobile Client Engagements API
  version: 1.0.0
extends: openapi/listrak-app-push-mobile-client-engagements-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: 1
- target: $.paths['/device/{deviceUid}/engagement'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a push engagement from a device
      effect: write
      questions:
      - How do I report that a user opened or interacted with a push notification?
      - What does Listrak need to log an engagement event against a specific push send?
      instructions:
      - text: Record a {type} engagement on device {deviceUid} for push send {sendUid}.
        slots:
          type: requestBody.type
          deviceUid: path.deviceUid
          sendUid: requestBody.sendUid
      - text: Log that device {deviceUid} engaged with send {sendUid}.
        slots:
          deviceUid: path.deviceUid
          sendUid: requestBody.sendUid
      method: generated
      generated: '2026-09-26'