Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Webhooks API

6 actions 6 updates phrasing extends openapi/harness-org-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/orgs/{org}/webhooks/list'].post

$.paths['/v1/orgs/{org}/webhooks'].post

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

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

$.paths['/v1/orgs/{org}/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 Org Webhooks API
  version: 1.0.0
extends: openapi/harness-org-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/orgs/{org}/webhooks/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List webhooks in an organization
      effect: read
      questions:
      - What webhooks are configured at the organization level?
      - Can I list only one type of org webhook?
      instructions:
      - text: List the webhooks in org {org}.
        slots:
          org: path.org
      - text: Show {webhook_type} webhooks configured for org {org}.
        slots:
          webhook_type: requestBody.webhook_type
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an org-level webhook
      effect: write
      questions:
      - How do I set up a webhook that applies across a whole organization?
      - What identifier, name and spec does a new org webhook need?
      instructions:
      - text: Create webhook {webhook_name} ({webhook_identifier}) in org {org} with spec {spec}.
        slots:
          webhook_name: requestBody.webhook_name
          webhook_identifier: requestBody.webhook_identifier
          org: path.org
          spec: requestBody.spec
      - text: Add an org webhook named {webhook_name} to {org}.
        slots:
          webhook_name: requestBody.webhook_name
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/webhooks/{webhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org-level webhook
      effect: read
      questions:
      - Can I see how a specific organization webhook is configured?
      - Is a given org webhook enabled?
      instructions:
      - text: Show webhook {webhook} in org {org}.
        slots:
          webhook: path.webhook
          org: path.org
      - text: Fetch org {org}'s webhook {webhook} configuration.
        slots:
          org: path.org
          webhook: path.webhook
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/webhooks/{webhook}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or disable an org webhook
      effect: write
      questions:
      - How can I disable an org webhook without deleting it?
      - Can I rename an org webhook or change its spec?
      instructions:
      - text: 'Update webhook {webhook} in org {org}: name {webhook_name}, enabled {is_enabled}, spec {spec}.'
        slots:
          webhook: path.webhook
          org: path.org
          webhook_name: requestBody.webhook_name
          is_enabled: requestBody.is_enabled
          spec: requestBody.spec
      - text: Set org webhook {webhook} enabled to {is_enabled}.
        slots:
          webhook: path.webhook
          is_enabled: requestBody.is_enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/webhooks/{webhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an org-level webhook
      effect: destructive
      questions:
      - Can I permanently remove a webhook from an organization?
      - What's the way to delete an org webhook we stopped using?
      instructions:
      - text: Delete webhook {webhook} from org {org}.
        slots:
          webhook: path.webhook
          org: path.org
      - text: Remove org {org}'s webhook {webhook} permanently.
        slots:
          org: path.org
          webhook: path.webhook
      method: generated
      generated: '2026-09-26'