Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Target Failures API

3 actions 3 updates phrasing extends openapi/zendesk-target-failures-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 3

$.info
$.paths['/api/v2/target_failures'].get
$.paths['/api/v2/target_failures/{target_failure_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 Zendesk Target Failures API
  version: 1.0.0
extends: openapi/zendesk-target-failures-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['/api/v2/target_failures'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent target failures
      effect: read
      questions:
      - Why are my notification targets failing to deliver?
      - How many recent failures per target does the list return?
      instructions:
      - text: List the most recent target failures.
      - text: Show the last 25 failures for each target.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/target_failures/{target_failure_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a target failure
      effect: read
      questions:
      - Can I see the full response details for one target failure?
      - What was the error for a specific failed target delivery?
      instructions:
      - text: Show the details of that target failure.
      - text: Fetch one failed target delivery by its failure ID.
      method: generated
      generated: '2026-09-26'