Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Targets API

6 actions 6 updates phrasing extends openapi/zendesk-targets-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 6

$.info

$.paths['/api/v2/targets'].get

$.paths['/api/v2/targets'].post

$.paths['/api/v2/targets/{target_id}'].get

$.paths['/api/v2/targets/{target_id}'].put

$.paths['/api/v2/targets/{target_id}'].delete

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 Targets API
  version: 1.0.0
extends: openapi/zendesk-targets-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: 5
- target: $.paths['/api/v2/targets'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification targets
      effect: read
      questions:
      - What external targets are configured for notifications?
      - Can agents see the list of targets?
      instructions:
      - text: List all targets.
      - text: Show the external notification targets we have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/targets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification target
      effect: write
      questions:
      - Can I add an external target that triggers can notify?
      - Is creating a target admin-only?
      instructions:
      - text: Create a new notification target.
      - text: Add an email target for the operations team.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/targets/{target_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification target
      effect: read
      questions:
      - Where can I see how one target is configured?
      - Can I look up a single target's settings?
      instructions:
      - text: Show this target.
      - text: Get the operations team target.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/targets/{target_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a notification target
      effect: write
      questions:
      - Can I change the address or settings of an existing target?
      - Can I deactivate a target without deleting it?
      instructions:
      - text: Update this target's settings.
      - text: Deactivate the operations team target.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/targets/{target_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification target
      effect: destructive
      questions:
      - Can I remove a target I no longer need?
      - Who can delete a target?
      instructions:
      - text: Delete this target.
      - text: Remove the old notification target.
      method: generated
      generated: '2026-09-26'