# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Extensibility Conga Hooks API
  version: 1.0.0
extends: openapi/conga-conga-hooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules'].get
  update:
    x-apievangelist-phrasing:
      intent: List data change rules
      effect: read
      questions:
      - Which service hook data change rules are configured in my Conga org?
      - Can I search data change rules by criteria and sort them?
      instructions:
      - text: List all data change rules.
      - text: Find data change rules matching {criteria}, sorted by {sortField} {sortDirection}.
        slots:
          criteria: query.criteria
          sortField: query.sortField
          sortDirection: query.sortDirection
      - text: Show page {pageNumber} of data change rules.
        slots:
          pageNumber: query.pageNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data change rule
      effect: write
      questions:
      - How do I set up a service hook that runs custom code when an object's data changes?
      - Can I create a data change rule that only fires on certain event types?
      instructions:
      - text: Create a data change rule {Name} on object {ObjectName} for events {EventTypes}.
        slots:
          Name: requestBody.Name
          ObjectName: requestBody.ObjectName
          EventTypes: requestBody.EventTypes
      - text: Add a new active service hook rule {Name} with condition {Condition}.
        slots:
          Name: requestBody.Name
          Condition: requestBody.Condition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules/cancellation/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: View service hook cancellation settings
      effect: read
      questions:
      - What's the current cancellation token timeout configured for service hooks?
      - How do I check the ServiceHooks execution abort settings?
      instructions:
      - text: Show the service hook cancellation token settings.
      - text: Get the current ServiceHooks abort timeout configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules/cancellation/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set service hook cancellation timeout
      effect: write
      questions:
      - How do I change how long a service hook can run before it's aborted?
      - Can I configure the cancellation token setting if none exists yet?
      instructions:
      - text: Set the service hook execution abort timeout to {ExecutionAbortTimeout}.
        slots:
          ExecutionAbortTimeout: requestBody.ExecutionAbortTimeout
      - text: Create or update the ServiceHooks cancellation token setting.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules/supported-event-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported service hook event types
      effect: read
      questions:
      - Which event types can a data change rule listen for?
      - What events are supported by service hook rules?
      instructions:
      - text: List the event types supported by service hook rules.
      - text: Show which data change events I can trigger hooks on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data change rule by name
      effect: read
      questions:
      - How do I view the details of one data change rule?
      - Can I look up a service hook rule by its name?
      instructions:
      - text: Show the data change rule named {name}.
        slots:
          name: path.name
      - text: Get details of service hook rule {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data change rule
      effect: write
      questions:
      - How do I change the condition or event types on an existing data change rule?
      - Can I deactivate a service hook rule without deleting it?
      instructions:
      - text: Update data change rule {name} to listen for {EventTypes}.
        slots:
          name: path.name
          EventTypes: requestBody.EventTypes
      - text: Set IsActive to {IsActive} on existing rule {name}.
        slots:
          IsActive: requestBody.IsActive
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/datachangerules/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data change rule
      effect: destructive
      questions:
      - How do I remove a service hook data change rule I no longer need?
      - What gets validated before a data change rule is deleted?
      instructions:
      - text: Delete the data change rule {name}.
        slots:
          name: path.name
      - text: Remove service hook rule {name} permanently.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'