# 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 Triggers API
  version: 1.0.0
extends: openapi/harness-webhook-triggers-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: 7
- target: $.paths['/pipeline/api/webhook/triggerProcessingDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Check how a webhook trigger event was processed
      effect: read
      questions:
      - Did Harness receive and process the webhook event I sent to a pipeline trigger?
      - Why didn't my webhook trigger fire for a particular event?
      instructions:
      - text: Show the trigger processing details for webhook event {event_id}.
        slots:
          event_id: query.eventId
      - text: Look up whether webhook event {event_id} matched a trigger.
        slots:
          event_id: query.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/webhook/triggerExecutionDetails/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the pipeline execution a webhook event started
      effect: read
      questions:
      - Which pipeline execution did a given webhook event kick off?
      - Can I trace a webhook event through to the pipeline run it started?
      instructions:
      - text: Get the trigger execution details for webhook event {event_id}.
        slots:
          event_id: path.eventId
      - text: Find the pipeline run started by event {event_id}.
        slots:
          event_id: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/webhook/triggerExecutionDetailsV2/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a queued webhook trigger event
      effect: read
      questions:
      - Is my webhook event still queued before it has triggered the pipeline?
      - Can I see execution status for a webhook event that has not started a pipeline yet?
      instructions:
      - text: Check the queued trigger status of webhook event {event_id}.
        slots:
          event_id: path.eventId
      - text: Show v2 execution details for event {event_id} while it waits in the queue.
        slots:
          event_id: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/webhook/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Git webhook payload to pipeline triggers
      effect: write
      questions:
      - Where do I post a Git provider webhook payload so Harness pipeline triggers can react?
      - Can I replay a webhook payload to fire my Git-based triggers?
      instructions:
      - text: Send this webhook payload to the pipeline triggers in account {account}.
        slots:
          account: query.accountIdentifier
      - text: Deliver the Git event payload to triggers in project {project}.
        slots:
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/webhook/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Fire a custom webhook trigger (original endpoint)
      effect: write
      questions:
      - How do I fire a custom webhook trigger with my own payload using the original endpoint?
      - Can I target one pipeline's custom trigger with the first-version custom webhook URL?
      instructions:
      - text: Post a custom webhook payload to project {project} in org {org} using the original custom endpoint.
        slots:
          project: query.projectIdentifier
          org: query.orgIdentifier
      - text: Fire custom trigger {trigger} on pipeline {pipeline} via the v1 custom webhook.
        slots:
          trigger: query.triggerIdentifier
          pipeline: query.pipelineIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/webhook/custom/v2'].post
  update:
    x-apievangelist-phrasing:
      intent: Fire a custom webhook trigger (v2 endpoint)
      effect: write
      questions:
      - What is the v2 custom webhook endpoint for firing a custom trigger?
      - Can the v2 custom webhook target a specific trigger on a pipeline?
      instructions:
      - text: Send a custom payload to the v2 custom webhook for project {project} in org {org}.
        slots:
          project: query.projectIdentifier
          org: query.orgIdentifier
      - text: Invoke custom trigger {trigger} of pipeline {pipeline} through the v2 webhook.
        slots:
          trigger: query.triggerIdentifier
          pipeline: query.pipelineIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/webhook/custom/{webhookToken}/v3'].post
  update:
    x-apievangelist-phrasing:
      intent: Fire a custom webhook trigger with a webhook token
      effect: write
      questions:
      - How do I fire a custom trigger using a webhook token in the URL?
      - Can I call a custom webhook trigger with a token instead of an API key?
      instructions:
      - text: Fire the custom trigger for webhook token {token} in project {project}.
        slots:
          token: path.webhookToken
          project: query.projectIdentifier
      - text: Post my payload to v3 custom webhook {token} for pipeline {pipeline}.
        slots:
          token: path.webhookToken
          pipeline: query.pipelineIdentifier
      method: generated
      generated: '2026-09-26'