Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Webhooks API

6 actions 6 updates phrasing extends openapi/harness-account-webhooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/webhooks/list'].post

$.paths['/v1/webhooks'].post

$.paths['/v1/webhooks/{webhook}'].get

$.paths['/v1/webhooks/{webhook}'].put

$.paths['/v1/webhooks/{webhook}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Account Webhooks API
  version: 1.0.0
extends: openapi/harness-account-webhooks-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: 5
- target: $.paths['/v1/webhooks/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List account-level webhooks
      effect: read
      questions:
      - Which webhooks are configured at my account level?
      - Can I filter account webhooks by webhook type?
      instructions:
      - text: List all account-level webhooks.
      - text: Show account webhooks of type {webhook_type}.
        slots:
          webhook_type: requestBody.webhook_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level webhook
      effect: write
      questions:
      - How do I set up a webhook that applies across my whole account?
      - What goes in the spec when creating an account webhook?
      instructions:
      - text: Create account webhook {webhook_identifier} named {webhook_name} with spec {spec}.
        slots:
          webhook_identifier: requestBody.webhook_identifier
          webhook_name: requestBody.webhook_name
          spec: requestBody.spec
      - text: Add a new account-level webhook called {webhook_name}.
        slots:
          webhook_name: requestBody.webhook_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{webhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level webhook
      effect: read
      questions:
      - How is one of my account webhooks configured?
      - Can I fetch an account webhook by its identifier?
      instructions:
      - text: Get account webhook {webhook}.
        slots:
          webhook: path.webhook
      - text: Show the spec of account-level webhook {webhook}.
        slots:
          webhook: path.webhook
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{webhook}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level webhook
      effect: write
      questions:
      - Can I disable an account webhook without deleting it?
      - How do I change the spec of an existing account-level webhook?
      instructions:
      - text: Update account webhook {webhook} with spec {spec}.
        slots:
          webhook: path.webhook
          spec: requestBody.spec
      - text: Set account webhook {webhook} enabled to {is_enabled}.
        slots:
          webhook: path.webhook
          is_enabled: requestBody.is_enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{webhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level webhook
      effect: destructive
      questions:
      - How do I delete a webhook defined at account level?
      - Will deleting an account webhook stop triggers that rely on it?
      instructions:
      - text: Delete account webhook {webhook}.
        slots:
          webhook: path.webhook
      - text: Remove the account-level webhook {webhook}.
        slots:
          webhook: path.webhook
      method: generated
      generated: '2026-09-26'