Generated by API Evangelist
Written by API Evangelist tooling for MoEngage's API. It is a proposal applied on top of the contract, not a document MoEngage publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for MoEngage Broadcast Live Activities API
version: 1.0.0
extends: openapi/moengage-live-activities-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/live-activity/broadcast/start'].post
update:
x-apievangelist-phrasing:
intent: Start a broadcast Live Activity
effect: write
questions:
- How do I start an iOS Live Activity for a big audience, like a live match?
- Can I launch a shared real-time Live Activity for everyone subscribed?
instructions:
- text: Start broadcast Live Activity {broadcast_live_activity_id} with iOS content {ios}.
slots:
broadcast_live_activity_id: requestBody.broadcast_live_activity_id
ios: requestBody.ios
- text: Kick off instance {instance_id} of broadcast Live Activity {broadcast_live_activity_id} using {ios}.
slots:
instance_id: requestBody.instance_id
broadcast_live_activity_id: requestBody.broadcast_live_activity_id
ios: requestBody.ios
method: generated
generated: '2026-10-01'
- target: $.paths['/live-activity/broadcast/update'].post
update:
x-apievangelist-phrasing:
intent: Push an update to a running broadcast Live Activity
effect: write
questions:
- How do I push a new score to a Live Activity that is already running?
- Can one update reach every device subscribed to a broadcast Live Activity?
instructions:
- text: Update running broadcast Live Activity {broadcast_live_activity_id} with new state {ios}.
slots:
broadcast_live_activity_id: requestBody.broadcast_live_activity_id
ios: requestBody.ios
- text: Send the latest development {ios} to live instance {instance_id} of {broadcast_live_activity_id}.
slots:
ios: requestBody.ios
instance_id: requestBody.instance_id
broadcast_live_activity_id: requestBody.broadcast_live_activity_id
method: generated
generated: '2026-10-01'
- target: $.paths['/live-activity/broadcast/end'].post
update:
x-apievangelist-phrasing:
intent: End a broadcast Live Activity
effect: destructive
questions:
- How do I end a broadcast Live Activity on all devices when the event is over?
- Can I dismiss a Live Activity immediately instead of showing a final state?
instructions:
- text: End broadcast Live Activity {broadcast_live_activity_id} with final state {ios}.
slots:
broadcast_live_activity_id: requestBody.broadcast_live_activity_id
ios: requestBody.ios
- text: Terminate instance {instance_id} of broadcast Live Activity {broadcast_live_activity_id} using {ios}.
slots:
instance_id: requestBody.instance_id
broadcast_live_activity_id: requestBody.broadcast_live_activity_id
ios: requestBody.ios
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.