Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Webhook API

17 actions 17 updates phrasing extends openapi/harness-webhook-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 17 · first 16 shown; the file carries all of them

$.info

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks'].get

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks'].post

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}'].get

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}'].delete

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}'].patch

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions'].get

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}'].get

$.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger'].post

$.paths['/code/api/v1/webhooks'].get

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

$.paths['/code/api/v1/webhooks/{webhook_identifier}'].get

$.paths['/code/api/v1/webhooks/{webhook_identifier}'].delete

$.paths['/code/api/v1/webhooks/{webhook_identifier}'].patch

$.paths['/code/api/v1/webhooks/{webhook_identifier}/executions'].get

$.paths['/code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}'].get

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 Webhook API
  version: 1.0.0
extends: openapi/harness-webhook-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: 16
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks on a code repository
      effect: read
      questions:
      - Which webhooks are configured on one of my Harness Code repositories?
      - Can I search a repo's webhooks by name and sort them?
      instructions:
      - text: List the webhooks on repository {repo}.
        slots:
          repo: path.repo_identifier
      - text: Find webhooks on repo {repo} matching {query}.
        slots:
          repo: path.repo_identifier
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook to a code repository
      effect: write
      questions:
      - How do I send push and pull request events from a single repository to my endpoint?
      - Can I sign a repository webhook with a secret and add extra headers?
      instructions:
      - text: Add a webhook to repository {repo} that posts to {url}.
        slots:
          repo: path.repo_identifier
          url: requestBody.url
      - text: Create repo webhook {name} on {repo} calling {url} for triggers {triggers}.
        slots:
          name: requestBody.display_name
          repo: path.repo_identifier
          url: requestBody.url
          triggers: requestBody.triggers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository webhook
      effect: read
      questions:
      - What URL and triggers is a particular repository webhook set up with?
      - Can I inspect one repo webhook's settings by its identifier?
      instructions:
      - text: Show webhook {webhook} on repository {repo}.
        slots:
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      - text: Get the settings of repo webhook {webhook} in {repo}.
        slots:
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository webhook
      effect: destructive
      questions:
      - How do I stop a repository from calling a webhook endpoint permanently?
      - Can I remove a single webhook from one repo?
      instructions:
      - text: Delete webhook {webhook} from repository {repo}.
        slots:
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      - text: Remove the repo-level webhook {webhook} on {repo}.
        slots:
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a repository webhook
      effect: write
      questions:
      - Can I change the target URL or triggers of an existing repository webhook?
      - Is it possible to disable a repo webhook without deleting it?
      instructions:
      - text: Point webhook {webhook} on repository {repo} at {url}.
        slots:
          webhook: path.webhook_identifier
          repo: path.repo_identifier
          url: requestBody.url
      - text: Set enabled to {enabled} on repo webhook {webhook} in {repo}.
        slots:
          enabled: requestBody.enabled
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List deliveries of a repository webhook
      effect: read
      questions:
      - What deliveries has a repository webhook made recently?
      - Can I see whether my repo webhook calls are succeeding or failing?
      instructions:
      - text: List executions of webhook {webhook} on repository {repo}.
        slots:
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      - text: Show the last {limit} deliveries of repo webhook {webhook} in {repo}.
        slots:
          limit: query.limit
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one delivery of a repository webhook
      effect: read
      questions:
      - What request and response did one repository webhook delivery record?
      - Can I inspect a single failed repo webhook execution?
      instructions:
      - text: Show execution {execution} of webhook {webhook} on repository {repo}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      - text: Get the details of repo webhook delivery {execution} for {webhook} in {repo}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeliver a repository webhook event
      effect: write
      questions:
      - Can I resend a repository webhook delivery that failed?
      - Is there a way to replay a past repo webhook event to my endpoint?
      instructions:
      - text: Retrigger execution {execution} of webhook {webhook} on repository {repo}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      - text: Redeliver repo webhook event {execution} for {webhook} in {repo}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List account, org or project webhooks
      effect: read
      questions:
      - Which webhooks are defined at the account, organization or project level rather than on a repo?
      - Can I list project-wide code webhooks sorted by name?
      instructions:
      - text: List the webhooks for project {project}.
        slots:
          project: query.projectIdentifier
      - text: Show org-level webhooks in {org} matching {query}.
        slots:
          org: query.orgIdentifier
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account, org or project webhook
      effect: write
      questions:
      - How do I get events from every repository in a project with one webhook?
      - Can I create an organization-wide webhook instead of one per repo?
      instructions:
      - text: Create a project webhook in {project} that posts to {url}.
        slots:
          project: query.projectIdentifier
          url: requestBody.url
      - text: Add org-wide webhook {name} in {org} calling {url} with secret {secret}.
        slots:
          name: requestBody.display_name
          org: query.orgIdentifier
          url: requestBody.url
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks/{webhook_identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account, org or project webhook
      effect: read
      questions:
      - What is configured on a project-level webhook?
      - Can I read one organization webhook by its identifier?
      instructions:
      - text: Show project-level webhook {webhook}.
        slots:
          webhook: path.webhook_identifier
      - text: Get org webhook {webhook} in {org}.
        slots:
          webhook: path.webhook_identifier
          org: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks/{webhook_identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account, org or project webhook
      effect: destructive
      questions:
      - How do I delete a webhook that applies to a whole project?
      - Can I remove an account-level code webhook?
      instructions:
      - text: Delete project webhook {webhook}.
        slots:
          webhook: path.webhook_identifier
      - text: Remove org-level webhook {webhook} from {org}.
        slots:
          webhook: path.webhook_identifier
          org: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks/{webhook_identifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an account, org or project webhook
      effect: write
      questions:
      - Can I change the URL or events of a project-wide webhook?
      - Is it possible to allow insecure TLS on an org webhook?
      instructions:
      - text: Point project webhook {webhook} at {url}.
        slots:
          webhook: path.webhook_identifier
          url: requestBody.url
      - text: Change the triggers of org webhook {webhook} to {triggers}.
        slots:
          webhook: path.webhook_identifier
          triggers: requestBody.triggers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks/{webhook_identifier}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List deliveries of a project-level webhook
      effect: read
      questions:
      - What deliveries has my project-wide webhook sent lately?
      - Can I page through an org webhook's execution history?
      instructions:
      - text: List executions of project webhook {webhook}.
        slots:
          webhook: path.webhook_identifier
      - text: Show page {page} of deliveries for org webhook {webhook}.
        slots:
          page: query.page
          webhook: path.webhook_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one delivery of a project-level webhook
      effect: read
      questions:
      - What happened on a single delivery from my account-level webhook?
      - Can I see the response my endpoint returned to a project webhook call?
      instructions:
      - text: Show execution {execution} of project webhook {webhook}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
      - text: Get delivery {execution} details for org webhook {webhook}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeliver a project-level webhook event
      effect: write
      questions:
      - Can I replay a failed delivery from an organization webhook?
      - Is there a way to resend an account-level webhook event after fixing my endpoint?
      instructions:
      - text: Retrigger execution {execution} of project webhook {webhook}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
      - text: Resend org webhook delivery {execution} for {webhook}.
        slots:
          execution: path.webhook_execution_id
          webhook: path.webhook_identifier
      method: generated
      generated: '2026-09-26'