Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Incremental Export API

8 actions 8 updates phrasing extends openapi/zendesk-incremental-export-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/v2/incremental/{incremental_resource}/sample'].get

$.paths['/api/v2/incremental/organizations'].get

$.paths['/api/v2/incremental/ticket_events'].get

$.paths['/api/v2/incremental/tickets'].get

$.paths['/api/v2/incremental/tickets/cursor'].get

$.paths['/api/v2/incremental/users'].get

$.paths['/api/v2/incremental/users/cursor'].get

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 Zendesk Incremental Export API
  version: 1.0.0
extends: openapi/zendesk-incremental-export-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['/api/v2/incremental/{incremental_resource}/sample'].get
  update:
    x-apievangelist-phrasing:
      intent: Sample an incremental export
      effect: read
      questions:
      - Can I test the incremental export format before running a full export?
      - What are the tighter rate limits on the sample export?
      instructions:
      - text: Run a sample incremental export for tickets.
      - text: Fetch up to 50 sample records to preview the export format.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/incremental/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Export organizations changed since a time
      effect: read
      questions:
      - Can I pull every organization that changed since my last sync?
      - Which organizations were updated recently, in export form?
      instructions:
      - text: Export organizations changed since yesterday.
      - text: Incrementally sync all updated organizations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/incremental/ticket_events'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a stream of ticket events
      effect: read
      questions:
      - Can I get a stream of field changes made to tickets?
      - Why are events from the last minute missing from the ticket event export?
      instructions:
      - text: Export ticket events since last night.
      - text: Stream every ticket field change since my last sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/incremental/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: Export changed tickets by start time
      effect: read
      questions:
      - Can I export tickets changed since a timestamp using time-based paging?
      - Which tickets changed since a given time, via the time-based export?
      instructions:
      - text: Export tickets changed since this start time using time-based pagination.
      - text: Run a time-based incremental ticket export.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/incremental/tickets/cursor'].get
  update:
    x-apievangelist-phrasing:
      intent: Export changed tickets with a cursor
      effect: read
      questions:
      - Is there a cursor-based way to export tickets changed since a time?
      - Can I resume a ticket export from where my last cursor stopped?
      instructions:
      - text: Export changed tickets using cursor pagination.
      - text: Continue the cursor-based ticket export from my saved cursor.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/incremental/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Export changed users by start time
      effect: read
      questions:
      - Can I export users updated since a timestamp with time-based paging?
      - Which users changed since a given time, via the time-based export?
      instructions:
      - text: Export users changed since this start time using time-based pagination.
      - text: Run a time-based incremental user export.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/incremental/users/cursor'].get
  update:
    x-apievangelist-phrasing:
      intent: Export changed users with a cursor
      effect: read
      questions:
      - Is there a cursor-based export for users that changed?
      - Can I resume a user export from my last cursor?
      instructions:
      - text: Export changed users using cursor pagination.
      - text: Continue the cursor-based user export from my saved cursor.
      method: generated
      generated: '2026-09-26'