MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Business Events API

4 actions 4 updates phrasing extends openapi/moengage-business-events-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 4

$.info
$.paths['/business_event'].post
$.paths['/business_event/trigger'].post
$.paths['/business_event/search'].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 MoEngage Business Events API
  version: 1.0.0
extends: openapi/moengage-business-events-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['/business_event'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new business event
      effect: write
      questions:
      - How do I set up a business event in MoEngage that campaigns can be triggered by?
      - Can I define attributes on a business event, like a flight number or a new price?
      - What do I need to register a business event before it can fire campaigns?
      instructions:
      - text: Create a business event named {event_name} with attributes {event_attributes}, created by {created_by}.
        slots:
          event_name: requestBody.event_name
          event_attributes: requestBody.event_attributes
          created_by: requestBody.created_by
      - text: Register a new business event called {event_name} so I can build event-triggered campaigns on it.
        slots:
          event_name: requestBody.event_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/business_event/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Fire a business event to start campaigns
      effect: write
      questions:
      - How do I fire a business event so the campaigns listening for it go out?
      - Can I pass attribute values when I trigger an existing business event, like the delayed flight's details?
      - What happens to event-triggered campaigns when I trigger a business event through the API?
      instructions:
      - text: Trigger the business event {event_name} with attributes {event_attributes}.
        slots:
          event_name: requestBody.event_name
          event_attributes: requestBody.event_attributes
      - text: Fire {event_name} now on behalf of {triggered_by} so its campaigns run.
        slots:
          event_name: requestBody.event_name
          triggered_by: requestBody.triggered_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/business_event/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up business events by ID or name
      effect: read
      questions:
      - Which business events have I already defined, looked up by their IDs?
      - Can I find a business event's definition by its name instead of its ID?
      instructions:
      - text: Look up the business events with IDs {event_ids}.
        slots:
          event_ids: requestBody.event_ids
      - text: Search business events named {event_names}.
        slots:
          event_names: requestBody.event_names
      method: generated
      generated: '2026-10-01'