# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Webhooks API
  version: 1.0.0
extends: openapi/jira-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['/rest/api/3/webhook'].get
  update:
    x-apievangelist-phrasing:
      intent: List my app's registered webhooks
      effect: read
      questions:
      - Which webhooks has my app registered in Jira?
      - Can I page through the dynamic webhooks my app owns?
      instructions:
      - text: List the webhooks registered by my app.
      - text: Show {maxResults} of my app's dynamic webhooks starting at {startAt}.
        slots:
          maxResults: query.maxResults
          startAt: query.startAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Register webhooks for my app
      effect: write
      questions:
      - How do I subscribe my app to Jira issue events with a webhook?
      - Why aren't webhooks from my private OAuth app being delivered?
      instructions:
      - text: Register webhooks {webhooks} delivering to {url}.
        slots:
          webhooks: requestBody.webhooks
          url: requestBody.url
      - text: 'Subscribe {url} to these Jira events: {webhooks}.'
        slots:
          url: requestBody.url
          webhooks: requestBody.webhooks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/webhook'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete my app's webhooks
      effect: destructive
      questions:
      - Can I unregister webhooks my app created?
      - What happens if I try to delete webhooks owned by another app?
      instructions:
      - text: Delete webhooks {webhookIds}.
        slots:
          webhookIds: requestBody.webhookIds
      - text: Unregister my app's webhooks with IDs {webhookIds}.
        slots:
          webhookIds: requestBody.webhookIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/webhook/failed'].get
  update:
    x-apievangelist-phrasing:
      intent: List failed webhook deliveries
      effect: read
      questions:
      - Which webhook deliveries to my app failed after all retries?
      - How long are failed webhook deliveries kept?
      instructions:
      - text: List webhooks that recently failed to deliver to my app.
      - text: Show failed webhook deliveries after cursor {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/webhook/refresh'].put
  update:
    x-apievangelist-phrasing:
      intent: Extend the life of webhooks
      effect: write
      questions:
      - Do API-registered webhooks expire, and can I keep them alive?
      - Can I extend webhooks for another 30 days before they lapse?
      instructions:
      - text: Extend the life of webhooks {webhookIds}.
        slots:
          webhookIds: requestBody.webhookIds
      - text: Refresh webhooks {webhookIds} so they don't expire.
        slots:
          webhookIds: requestBody.webhookIds
      method: generated
      generated: '2026-09-26'