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 Transactional API
version: 1.0.0
extends: openapi/moengage-transactional-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: 2
- target: $.paths['/transaction/sendpush'].post
update:
x-apievangelist-phrasing:
intent: Send a push campaign via the original endpoint
effect: write
questions:
- How do I send a push campaign with the older sendpush endpoint that takes appId and signature in the body?
- Does the original push endpoint work out the audience from targetAudience without a query-type header?
instructions:
- text: Using the original sendpush endpoint with signature {signature}, send campaign {campaignName} for app {appId} to {targetAudience}.
slots:
signature: requestBody.signature
campaignName: requestBody.campaignName
appId: requestBody.appId
targetAudience: requestBody.targetAudience
- text: Send legacy push {payload} on {targetPlatform} for app {appId}, delivery {campaignDelivery}, signed {signature}, as {campaignName} to {targetAudience}.
slots:
payload: requestBody.payload
targetPlatform: requestBody.targetPlatform
appId: requestBody.appId
campaignDelivery: requestBody.campaignDelivery
signature: requestBody.signature
campaignName: requestBody.campaignName
targetAudience: requestBody.targetAudience
method: generated
generated: '2026-10-01'
- target: $.paths['/v2.1/transaction/sendpush'].post
update:
x-apievangelist-phrasing:
intent: Send a push notification campaign
effect: write
questions:
- How do I send a push notification to one user by a unique attribute?
- Can I send a push to all users or a custom segment through the API?
- Can I personalize the push payload per user?
instructions:
- text: Send push campaign {campaignName} to {targetAudience} on {targetPlatform} with payload {payload}, delivery {campaignDelivery}.
slots:
campaignName: requestBody.campaignName
targetAudience: requestBody.targetAudience
targetPlatform: requestBody.targetPlatform
payload: requestBody.payload
campaignDelivery: requestBody.campaignDelivery
- text: Push {payload} to segment {customSegmentName} on {targetPlatform} as {campaignName}.
slots:
payload: requestBody.payload
customSegmentName: requestBody.customSegmentName
targetPlatform: requestBody.targetPlatform
campaignName: requestBody.campaignName
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.