Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Events API

8 actions 8 updates phrasing extends openapi/leadping-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Leadping's API. It is a proposal applied on top of the contract, not a document Leadping publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/events/all/my'].post

$.paths['/events/organizations/{organizationId}'].post

$.paths['/events/conversations/{conversationId}'].post

$.paths['/events/leads/{leadId}'].post

$.paths['/events/{eventId}'].get

$.paths['/events/detail/{eventId}'].get

$.paths['/events/conversations/{conversationId}/notes'].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 Leadping Events API
  version: 1.0.0
extends: openapi/leadping-events-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: 7
- target: $.paths['/events/all/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List my lead events
      effect: read
      questions:
      - What lead, SMS, call and automation events can I see?
      - Can I filter my events by category and date range?
      instructions:
      - text: List my events in category {category}.
        slots:
          category: query.category
      - text: Show my lead events between {startAt} and {endAt}.
        slots:
          startAt: query.startAt
          endAt: query.endAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/organizations/{organizationId}'].post
  update:
    x-apievangelist-phrasing:
      intent: List an organization's event history
      effect: read
      questions:
      - How can an admin review every event across an organization?
      - Can I pull organization-wide events for a date range?
      instructions:
      - text: List events for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show organization {organizationId} events from {startAt} to {endAt}.
        slots:
          organizationId: path.organizationId
          startAt: query.startAt
          endAt: query.endAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/conversations/{conversationId}'].post
  update:
    x-apievangelist-phrasing:
      intent: List a conversation's events
      effect: read
      questions:
      - What notes, messages and calls happened in one conversation?
      - Can I see the full timeline of a single conversation thread?
      instructions:
      - text: List events in conversation {conversationId}.
        slots:
          conversationId: path.conversationId
      - text: Show the timeline for conversation {conversationId}.
        slots:
          conversationId: path.conversationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/leads/{leadId}'].post
  update:
    x-apievangelist-phrasing:
      intent: List a lead's event history
      effect: read
      questions:
      - What has happened with a lead across routing, automation and messaging?
      - Can I see every event recorded for one lead?
      instructions:
      - text: List events for lead {leadId}.
        slots:
          leadId: path.leadId
      - text: Show the full event history of lead {leadId}.
        slots:
          leadId: path.leadId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event summary
      effect: read
      questions:
      - How do I look up one event's type, timestamps and related records?
      - Which entities is a particular event linked to?
      instructions:
      - text: Get event {eventId}.
        slots:
          eventId: path.eventId
      - text: Show the summary of event {eventId}.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/detail/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event's full payload
      effect: read
      questions:
      - Can I see the raw JSON payload of an event for debugging?
      - Where do I get the complete detail of an event for an audit?
      instructions:
      - text: Get the full JSON payload for event {eventId}.
        slots:
          eventId: path.eventId
      - text: Show detailed debug data for event {eventId}.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/conversations/{conversationId}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a conversation
      effect: write
      questions:
      - How do I leave a handoff note on a conversation?
      - Can I document lead context inside a conversation thread?
      instructions:
      - text: 'Add a note to conversation {conversationId}: {text}.'
        slots:
          conversationId: path.conversationId
          text: requestBody.text
      - text: Write the note "{text}" on conversation {conversationId}.
        slots:
          text: requestBody.text
          conversationId: path.conversationId
      method: generated
      generated: '2026-09-26'