# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Project Webhooks API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/webhooks/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List project-level webhooks
      effect: read
      questions:
      - Which webhooks are configured inside a project?
      - Can I filter a project's webhooks by type?
      instructions:
      - text: List webhooks in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show project {project} webhooks of type {webhook_type}.
        slots:
          project: path.project
          webhook_type: requestBody.webhook_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project-level webhook
      effect: write
      questions:
      - How do I add a webhook scoped to just one project?
      - What identifier, name and spec does a project webhook need?
      instructions:
      - text: Create webhook {webhook_identifier} named {webhook_name} in project {project} of org {org}.
        slots:
          webhook_identifier: requestBody.webhook_identifier
          webhook_name: requestBody.webhook_name
          project: path.project
          org: path.org
      - text: Add a project webhook in {org}/{project} with spec {spec}.
        slots:
          org: path.org
          project: path.project
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/webhooks/{webhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project-level webhook
      effect: read
      questions:
      - How is a particular project webhook set up?
      - Can I fetch one project's webhook by identifier?
      instructions:
      - text: Get webhook {webhook} in project {project} of org {org}.
        slots:
          webhook: path.webhook
          project: path.project
          org: path.org
      - text: Show the spec of project webhook {webhook} in {org}/{project}.
        slots:
          webhook: path.webhook
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/webhooks/{webhook}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project-level webhook
      effect: write
      questions:
      - Can I turn off a project webhook but keep its configuration?
      - How do I rename a webhook inside a project?
      instructions:
      - text: Update project webhook {webhook} in {org}/{project} with spec {spec}.
        slots:
          webhook: path.webhook
          org: path.org
          project: path.project
          spec: requestBody.spec
      - text: Set is_enabled to {is_enabled} on webhook {webhook} in project {project}.
        slots:
          is_enabled: requestBody.is_enabled
          webhook: path.webhook
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/webhooks/{webhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project-level webhook
      effect: destructive
      questions:
      - How do I delete a webhook from a project?
      - Is removing a project webhook permanent?
      instructions:
      - text: Delete webhook {webhook} from project {project} in org {org}.
        slots:
          webhook: path.webhook
          project: path.project
          org: path.org
      - text: Remove project webhook {webhook} in {org}/{project}.
        slots:
          webhook: path.webhook
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'