Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Live Notifications API

5 actions 5 updates phrasing extends openapi/customer-io-live-notifications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Customer.io's API. It is a proposal applied on top of the contract, not a document Customer.io publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/live_notifications/start'].post
$.paths['/v1/live_notifications/update'].post
$.paths['/v1/live_notifications/end'].post
$.paths['/v1/live_notifications/{instance_id}'].get

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 Customer.io App Live Notifications API
  version: 1.0.0
extends: openapi/customer-io-live-notifications-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: 4
- target: $.paths['/v1/live_notifications/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a live notification
      effect: write
      questions:
      - How do I start a Live Activity on someone's iPhone lock screen?
      - What do I need to start a live notification for a profile?
      instructions:
      - text: Start a {notification_type} live notification for {identifiers} with state {content_state}.
        slots:
          notification_type: requestBody.notification_type
          identifiers: requestBody.identifiers
          content_state: requestBody.content_state
      - text: Start a live notification of type {notification_type} for {identifiers} using attributes {attributes} and state {content_state}.
        slots:
          notification_type: requestBody.notification_type
          identifiers: requestBody.identifiers
          attributes: requestBody.attributes
          content_state: requestBody.content_state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/live_notifications/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a running live notification
      effect: write
      questions:
      - How do I push a new state to a Live Activity that's already running?
      - Do I need to send the full content state when updating a live notification?
      instructions:
      - text: Update live notification {instance_id} with state {content_state}.
        slots:
          instance_id: requestBody.instance_id
          content_state: requestBody.content_state
      - text: Push new content {content_state} to running activity {instance_id}.
        slots:
          content_state: requestBody.content_state
          instance_id: requestBody.instance_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/live_notifications/end'].post
  update:
    x-apievangelist-phrasing:
      intent: End a live notification
      effect: destructive
      questions:
      - How do I end a Live Activity and dismiss it from the lock screen?
      - Can I send a final state when ending a live notification?
      instructions:
      - text: End live notification {instance_id}.
        slots:
          instance_id: requestBody.instance_id
      - text: Finish activity {instance_id} with final state {content_state}.
        slots:
          instance_id: requestBody.instance_id
          content_state: requestBody.content_state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/live_notifications/{instance_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live notification's status
      effect: read
      questions:
      - Is a live notification still running, and was its last update delivered?
      - How do I check the lifecycle of a Live Activity?
      instructions:
      - text: Get the status of live notification {instance_id}.
        slots:
          instance_id: path.instance_id
      - text: Check whether activity {instance_id} is still active.
        slots:
          instance_id: path.instance_id
      method: generated
      generated: '2026-09-26'