Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk X Channel API

5 actions 5 updates phrasing extends openapi/zendesk-x-channel-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 5

$.info
$.paths['/api/v2/channels/twitter/monitored_twitter_handles'].get
$.paths['/api/v2/channels/twitter/monitored_twitter_handles/{monitored_twitter_handle_id}'].get
$.paths['/api/v2/channels/twitter/tickets'].post
$.paths['/api/v2/channels/twitter/tickets/{comment_id}/statuses'].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 Zendesk X Channel API
  version: 1.0.0
extends: openapi/zendesk-x-channel-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['/api/v2/channels/twitter/monitored_twitter_handles'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored X handles
      effect: read
      questions:
      - Which X (Twitter) handles is my help desk monitoring?
      - Can agents see the monitored X accounts?
      instructions:
      - text: List the X handles we monitor.
      - text: Show all monitored Twitter accounts in the channel.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/channels/twitter/monitored_twitter_handles/{monitored_twitter_handle_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a monitored X handle
      effect: read
      questions:
      - Can I view the settings of one monitored X handle?
      - What details are stored for a single monitored Twitter account?
      instructions:
      - text: Show the monitored X handle with that ID.
      - text: Fetch one monitored Twitter handle's details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/channels/twitter/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn a tweet into a ticket
      effect: write
      questions:
      - How do I create a support ticket from a customer's tweet?
      - What do I need to provide to convert a post on X into a ticket?
      instructions:
      - text: Create a ticket from this tweet using our monitored handle.
      - text: Convert the customer's post on X into a support ticket.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/channels/twitter/tickets/{comment_id}/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tweet status of a ticket's comments
      effect: read
      questions:
      - Can I see the X status of the tweets behind a ticket's comments?
      - Is it possible to check tweet info for only certain comments?
      instructions:
      - text: Get the tweet statuses for the ticket's comments.
      - text: Show tweet information for comments {ids} only.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'