Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Triggers API

14 actions 14 updates phrasing extends openapi/zendesk-triggers-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 14

$.info
$.paths['/api/v2/triggers/search'].get
$.paths['/api/v2/triggers'].get
$.paths['/api/v2/triggers'].post
$.paths['/api/v2/triggers/{trigger_id}'].get
$.paths['/api/v2/triggers/{trigger_id}'].put
$.paths['/api/v2/triggers/{trigger_id}'].delete
$.paths['/api/v2/triggers/{trigger_id}/revisions'].get
$.paths['/api/v2/triggers/{trigger_id}/revisions/{trigger_revision_id}'].get
$.paths['/api/v2/triggers/active'].get
$.paths['/api/v2/triggers/definitions'].get
$.paths['/api/v2/triggers/destroy_many'].delete
$.paths['/api/v2/triggers/reorder'].put
$.paths['/api/v2/triggers/update_many'].put

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 Triggers API
  version: 1.0.0
extends: openapi/zendesk-triggers-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: 13
- target: $.paths['/api/v2/triggers/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search ticket triggers
      effect: read
      questions:
      - Can I search my ticket triggers by a keyword?
      - Which triggers mention a certain word in their title?
      instructions:
      - text: Search triggers for the word escalation.
      - text: Find ticket triggers whose name matches VIP.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List all ticket triggers
      effect: read
      questions:
      - What ticket triggers exist in my account, active or not?
      - Can I page through every ticket trigger 100 at a time?
      instructions:
      - text: List all ticket triggers, including inactive ones.
      - text: Show every business rule trigger in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ticket trigger
      effect: write
      questions:
      - Can I set up a rule that fires automatically when a ticket changes?
      - What does it take to add a new trigger with conditions and actions?
      instructions:
      - text: Create a trigger that notifies the requester when a ticket is solved.
      - text: Add a new ticket trigger that assigns urgent tickets to Tier 2.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/{trigger_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticket trigger
      effect: read
      questions:
      - Where can I see the conditions and actions of one trigger?
      - Why does a trigger's via type show up as a number?
      instructions:
      - text: Show me the details of this trigger.
      - text: Get the conditions and actions for the escalation trigger.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/{trigger_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a ticket trigger
      effect: write
      questions:
      - If I change one condition on a trigger, do I lose the existing actions?
      - Can I rename or edit the actions of an existing trigger?
      instructions:
      - text: Update this trigger's conditions, keeping all of its actions.
      - text: Edit the escalation trigger to also add the urgent tag.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/{trigger_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ticket trigger
      effect: destructive
      questions:
      - Can I remove a single trigger I no longer need?
      - What happens to tickets when I delete one trigger?
      instructions:
      - text: Delete this ticket trigger.
      - text: Remove the old welcome email trigger.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/{trigger_id}/revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a trigger's revision history
      effect: read
      questions:
      - Can I see who changed a trigger and when?
      - Is trigger revision history only on Enterprise plans?
      instructions:
      - text: List the revisions of this trigger.
      - text: Show the change history for the escalation trigger.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/{trigger_id}/revisions/{trigger_revision_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one revision of a trigger
      effect: read
      questions:
      - What did a trigger look like at a specific earlier revision?
      - Can I fetch a single past version of a trigger?
      instructions:
      - text: Show me that specific revision of the trigger.
      - text: Fetch revision 3 of the escalation trigger.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/active'].get
  update:
    x-apievangelist-phrasing:
      intent: List active ticket triggers
      effect: read
      questions:
      - Which triggers are currently switched on?
      - Can I see only the triggers that are active right now?
      instructions:
      - text: List the active ticket triggers.
      - text: Show only enabled triggers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List trigger condition and action definitions
      effect: read
      questions:
      - What conditions and actions can a trigger use?
      - Which values are allowed for a trigger condition like status?
      instructions:
      - text: List the available trigger conditions and actions.
      - text: Show the definitions I can use to build a trigger.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several triggers at once
      effect: destructive
      questions:
      - Can I remove a list of triggers by id in one request?
      - Is there a bulk delete for old triggers?
      instructions:
      - text: Delete these triggers by id in bulk.
      - text: Remove all of the obsolete triggers in this list together.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/reorder'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the firing order of triggers
      effect: write
      questions:
      - Can I control which trigger fires first?
      - How does trigger order affect what happens to a ticket?
      instructions:
      - text: Reorder the triggers so the escalation rule fires first.
      - text: Set the firing order of triggers to this sequence.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/triggers/update_many'].put
  update:
    x-apievangelist-phrasing:
      intent: Update position or active status of many triggers
      effect: write
      questions:
      - Can I activate or deactivate several triggers in one call?
      - Which trigger properties can a bulk update change?
      instructions:
      - text: Deactivate these triggers in bulk.
      - text: Update the position and active flag for this set of triggers.
      method: generated
      generated: '2026-09-26'