Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Events API

3 actions 3 updates phrasing extends openapi/contentstack-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Contentstack's API. It is a proposal applied on top of the contract, not a document Contentstack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/events'].get
$.paths['/events'].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 Contentstack Events API
  version: 1.0.0
extends: openapi/contentstack-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: 2
- target: $.paths['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom event definitions
      effect: read
      questions:
      - Which custom events are defined in my Personalize project?
      - What events can I track to update audience membership?
      instructions:
      - text: List the custom events defined in project {project}.
        slots:
          project: header.x-project-uid
      - text: Show all event definitions for Personalize project {project}.
        slots:
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track user events
      effect: write
      questions:
      - How do I record an impression when a visitor sees an experience?
      - Can I send custom user events to update audience membership?
      instructions:
      - text: Track events for user {user} in project {project}.
        slots:
          user: header.x-cs-personalize-user-uid
          project: header.x-project-uid
      - text: Record an impression event for visitor {user} in Personalize project {project}.
        slots:
          user: header.x-cs-personalize-user-uid
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'