Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Object Triggers API

11 actions 11 updates phrasing extends openapi/zendesk-object-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 11

$.info
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers'].get
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers'].post
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers/{trigger_id}'].get
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers/{trigger_id}'].put
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers/{trigger_id}'].delete
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers/active'].get
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers/definitions'].get
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers/destroy_many'].delete
$.paths['/api/v2/custom_objects/{custom_object_key}/triggers/search'].get
$.paths['/api/v2/custom_objects/{custom_object_key}/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 Object Triggers API
  version: 1.0.0
extends: openapi/zendesk-object-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: 10
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a custom object's triggers
      effect: read
      questions:
      - Which triggers are set up on one of my custom objects?
      - Can I see every trigger for a custom object, active or not?
      instructions:
      - text: List all triggers defined on my custom object.
      - text: Show every object trigger, including inactive ones, for that custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an object trigger
      effect: write
      questions:
      - How do I add a trigger that fires on changes to custom object records?
      - Who is allowed to create object triggers on Enterprise plans?
      instructions:
      - text: Create a new trigger for my custom object with these conditions and actions.
      - text: Add an object trigger that runs when a record of that object changes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/{trigger_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show an object trigger
      effect: read
      questions:
      - Can I view the conditions and actions of one specific object trigger?
      - What details come back for a single custom object trigger?
      instructions:
      - text: Show the details of one object trigger by its trigger ID.
      - text: Fetch a single trigger on my custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/{trigger_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object trigger
      effect: write
      questions:
      - Why did updating one condition clear the rest of my object trigger's actions?
      - Can I rename or change the conditions of an existing object trigger?
      instructions:
      - text: Update that object trigger, sending all its conditions and actions.
      - text: Change the title and conditions of one custom object trigger.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/{trigger_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object trigger
      effect: destructive
      questions:
      - Can I remove a single trigger from a custom object?
      - Which roles can delete an object trigger?
      instructions:
      - text: Delete one trigger from my custom object.
      - text: Remove the specified object trigger permanently.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/active'].get
  update:
    x-apievangelist-phrasing:
      intent: List active object triggers
      effect: read
      questions:
      - Which triggers on my custom object are currently active?
      - Can I page through only the enabled object triggers?
      instructions:
      - text: List only the active triggers on my custom object.
      - text: Show the enabled object triggers, 100 per page.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List object trigger condition and action definitions
      effect: read
      questions:
      - What conditions and actions are available when building a trigger for a custom object?
      - Where do I find the definitions I can use in object trigger rules?
      instructions:
      - text: Show the available trigger conditions and actions for my custom object.
      - text: Get the object trigger definitions so I can build a new rule.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/destroy_many'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete object triggers
      effect: destructive
      questions:
      - Can I delete several custom object triggers in one request?
      - Is bulk trigger deletion limited to one custom object at a time?
      instructions:
      - text: Delete this comma-separated list of object triggers on one custom object.
      - text: Bulk remove several triggers from my custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search object triggers
      effect: read
      questions:
      - Can I search a custom object's triggers by title?
      - What kind of filter can narrow an object trigger search?
      instructions:
      - text: Search my custom object's triggers for ones titled like 'escalation'.
      - text: Filter object triggers by title using a JSON filter.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/custom_objects/{custom_object_key}/triggers/update_many'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder or toggle many object triggers
      effect: write
      questions:
      - Can I change the firing order of several object triggers at once?
      - Is it possible to activate or deactivate multiple object triggers in one call?
      instructions:
      - text: Update the positions of these triggers on my custom object.
      - text: Deactivate several object triggers in bulk.
      method: generated
      generated: '2026-09-26'