Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Any Channel Channel Framework API

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

$.info
$.paths['/api/v2/any_channel/channelback/report_error'].post
$.paths['/api/v2/any_channel/push'].post
$.paths['/api/v2/any_channel/validate_token'].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 Zendesk Any Channel Channel Framework API
  version: 1.0.0
extends: openapi/zendesk-channel-framework-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: 3
- target: $.paths['/api/v2/any_channel/channelback/report_error'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a channelback error
      effect: write
      questions:
      - How do I report a failed channelback from my channel integration?
      - What information goes into a channelback error report?
      instructions:
      - text: Report this channelback error to Zendesk.
      - text: Log a failed channelback for my integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/any_channel/push'].post
  update:
    x-apievangelist-phrasing:
      intent: Push channel content into Zendesk
      effect: write
      questions:
      - Can my channel integration push messages into Zendesk as tickets?
      - What data does a push of channel content include?
      instructions:
      - text: Push these external messages into Zendesk.
      - text: Send new channel content from my integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/any_channel/validate_token'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a channel integration token
      effect: read
      questions:
      - Can I check whether my channel integration token is valid?
      - What does a token validation request contain?
      instructions:
      - text: Validate this channel framework token.
      - text: Check that my integration's token still works.
      method: generated
      generated: '2026-09-26'