MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Inform Transactional Alerts API

2 actions 2 updates phrasing extends openapi/moengage-transactional-alerts-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/alerts/send'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MoEngage Inform Transactional Alerts API
  version: 1.0.0
extends: openapi/moengage-transactional-alerts-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: 1
- target: $.paths['/alerts/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional alert to a user
      effect: write
      questions:
      - How do I send an order confirmation alert to a customer across channels?
      - Can I trigger an alert by its reference name instead of its alert ID?
      - What transaction details must accompany a transactional alert?
      instructions:
      - text: Send alert {alert_id} to user {user_id} for transaction {transaction_id} with payloads {payloads}.
        slots:
          alert_id: requestBody.alert_id
          user_id: requestBody.user_id
          transaction_id: requestBody.transaction_id
          payloads: requestBody.payloads
      - text: Trigger alert {alert_reference_name} for transaction {transaction_id} using {payloads}.
        slots:
          alert_reference_name: requestBody.alert_reference_name
          transaction_id: requestBody.transaction_id
          payloads: requestBody.payloads
      method: generated
      generated: '2026-10-01'