# 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 Rules API
  version: 1.0.0
extends: openapi/conga-conga-hooks-rules-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/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List service hook rules
      effect: read
      questions:
      - Which service hook rules are set up in my Conga platform?
      - Can I filter service hook rules by criteria and sort them?
      instructions:
      - text: List all service hook rules.
      - text: Find service hook rules matching {criteria}, page {pageNumber} with {pageSize} per page.
        slots:
          criteria: query.criteria
          pageNumber: query.pageNumber
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service hook rule
      effect: write
      questions:
      - How do I run custom code automatically when a record changes?
      - Can I create a scheduled rule instead of a data-change rule?
      - What do I need to define a new service hook rule?
      instructions:
      - text: Create a service hook rule {Name} on object {ObjectName} that fires on {EventTypes}.
        slots:
          Name: requestBody.Name
          ObjectName: requestBody.ObjectName
          EventTypes: requestBody.EventTypes
      - text: Add a new {RuleType} service hook rule named {Name} with schedule {ScheduleDetails}.
        slots:
          RuleType: requestBody.RuleType
          Name: requestBody.Name
          ScheduleDetails: requestBody.ScheduleDetails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/rules/cancellation/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the service hook cancellation timeout setting
      effect: read
      questions:
      - What abort timeout is configured for service hook executions?
      - Is a cancellation token setting configured for service hooks yet?
      instructions:
      - text: Show the current service hook cancellation token settings.
      - text: Tell me the execution abort timeout for service hooks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/rules/cancellation/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the service hook cancellation timeout
      effect: write
      questions:
      - How do I change how long a service hook can run before it is aborted?
      - Can I create the cancellation 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 cancellation token setting with timeout {ExecutionAbortTimeout}.
        slots:
          ExecutionAbortTimeout: requestBody.ExecutionAbortTimeout
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/rules/supported-event-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported service hook event types
      effect: read
      questions:
      - Which events can a service hook rule be triggered by?
      - What event types are supported when defining hook rules?
      instructions:
      - text: List every event type supported by service hook rules.
      - text: Show me the events I can attach a hook rule to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/rules/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service hook rule by name
      effect: read
      questions:
      - What condition and events does a particular service hook rule use?
      - Can I look up a single hook rule using its name?
      instructions:
      - text: Fetch the service hook rule named {name}.
        slots:
          name: path.name
      - text: Show the configuration of hook rule {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/rules/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service hook rule
      effect: destructive
      questions:
      - How do I remove a service hook rule I no longer want?
      - Can I delete a hook rule by its name?
      instructions:
      - text: Delete the service hook rule {name}.
        slots:
          name: path.name
      - text: Remove hook rule {name} permanently.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/servicehooks/rules/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service hook rule
      effect: write
      questions:
      - Can I deactivate a service hook rule without deleting it?
      - Is it possible to change the condition or events on an existing hook rule?
      instructions:
      - text: Set hook rule {name} active flag to {IsActive}.
        slots:
          name: path.name
          IsActive: requestBody.IsActive
      - text: Change the condition on service hook rule {name} to {Condition}.
        slots:
          name: path.name
          Condition: requestBody.Condition
      method: generated
      generated: '2026-10-01'