Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Trigger Categories API

7 actions 7 updates phrasing extends openapi/zendesk-trigger-categories-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 7

$.info
$.paths['/api/v2/trigger_categories'].get
$.paths['/api/v2/trigger_categories'].post
$.paths['/api/v2/trigger_categories/{trigger_category_id}'].get
$.paths['/api/v2/trigger_categories/{trigger_category_id}'].delete
$.paths['/api/v2/trigger_categories/{trigger_category_id}'].patch
$.paths['/api/v2/trigger_categories/jobs'].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 Trigger Categories API
  version: 1.0.0
extends: openapi/zendesk-trigger-categories-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: 6
- target: $.paths['/api/v2/trigger_categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket trigger categories
      effect: read
      questions:
      - What categories are my ticket triggers organized into?
      - Can I include rule counts when listing trigger categories?
      instructions:
      - text: List the ticket trigger categories sorted by {sort}.
        slots:
          sort: query.sort
      - text: Show the trigger categories including {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/trigger_categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ticket trigger category
      effect: write
      questions:
      - How do I add a new category to group my ticket triggers?
      - Can I set a category's position when I create it?
      instructions:
      - text: Create the trigger category {trigger_category}.
        slots:
          trigger_category: requestBody.trigger_category
      - text: Add a new ticket trigger category named Notifications.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/trigger_categories/{trigger_category_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a ticket trigger category
      effect: read
      questions:
      - Can I view a single trigger category by its ID?
      - What details are stored on one trigger category?
      instructions:
      - text: Show trigger category {trigger_category_id}.
        slots:
          trigger_category_id: path.trigger_category_id
      - text: Fetch the details of category {trigger_category_id}.
        slots:
          trigger_category_id: path.trigger_category_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/trigger_categories/{trigger_category_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ticket trigger category
      effect: destructive
      questions:
      - Can I remove a trigger category I no longer use?
      - Which call deletes one ticket trigger category?
      instructions:
      - text: Delete trigger category {trigger_category_id}.
        slots:
          trigger_category_id: path.trigger_category_id
      - text: Remove the unused category {trigger_category_id}.
        slots:
          trigger_category_id: path.trigger_category_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/trigger_categories/{trigger_category_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reposition a trigger category
      effect: write
      questions:
      - Can I rename an existing ticket trigger category?
      - Is it possible to change the position of one category?
      instructions:
      - text: Update trigger category {trigger_category_id} with {trigger_category}.
        slots:
          trigger_category_id: path.trigger_category_id
          trigger_category: requestBody.trigger_category
      - text: Rename category {trigger_category_id} to Escalations.
        slots:
          trigger_category_id: path.trigger_category_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/trigger_categories/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch update trigger categories and triggers
      effect: write
      questions:
      - Can I reorder several trigger categories in a single job?
      - Is there a batch job for operating on many ticket trigger categories at once?
      instructions:
      - text: Run a batch job to reposition my trigger categories.
      - text: Apply a batch operation across several ticket trigger categories.
      method: generated
      generated: '2026-09-26'