Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Webhooks API

8 actions 8 updates phrasing extends openapi/atlassian-webhooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/hook_events'].get

$.paths['/hook_events/{subject_type}'].get

$.paths['/rest/api/3/webhook'].get

$.paths['/rest/api/3/webhook'].post

$.paths['/rest/api/3/webhook'].delete

$.paths['/rest/api/3/webhook/failed'].get

$.paths['/rest/api/3/webhook/refresh'].put

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 Atlassian Webhooks API
  version: 1.0.0
extends: openapi/atlassian-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/hook_events'].get
  update:
    x-apievangelist-phrasing:
      intent: List Bitbucket webhook subject types
      effect: read
      questions:
      - What kinds of Bitbucket resources can I register webhooks on?
      - Where do I find the events each webhook subject type emits?
      instructions:
      - text: List the Bitbucket webhook subject types.
      - text: Show the resource types that accept Bitbucket webhooks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hook_events/{subject_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook events for a subject type
      effect: read
      questions:
      - Which webhook events can a Bitbucket workspace emit?
      - Are team and user webhook events deprecated?
      instructions:
      - text: List webhook events available for subject type {subject_type}.
        slots:
          subject_type: path.subject_type
      - text: Show all subscribable {subject_type} webhook events.
        slots:
          subject_type: path.subject_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/webhook'].get
  update:
    x-apievangelist-phrasing:
      intent: List my app's Jira dynamic webhooks
      effect: read
      questions:
      - Which Jira webhooks has my app registered?
      - Can only Connect and OAuth apps list their dynamic webhooks?
      instructions:
      - text: List the Jira 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-10-01'
- target: $.paths['/rest/api/3/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Register Jira dynamic webhooks
      effect: write
      questions:
      - How does my app subscribe to Jira issue events with a webhook?
      - Why might webhooks from a non-public OAuth app not be delivered?
      instructions:
      - text: Register webhooks {webhooks} delivering to {url}.
        slots:
          webhooks: requestBody.webhooks
          url: requestBody.url
      - text: Subscribe {url} to Jira events with webhook definitions {webhooks}.
        slots:
          url: requestBody.url
          webhooks: requestBody.webhooks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/webhook'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete my app's Jira webhooks by ID
      effect: destructive
      questions:
      - How do I unregister Jira webhooks my app created?
      - What happens if I try to delete webhooks owned by another app?
      instructions:
      - text: Delete Jira webhooks {webhookIds}.
        slots:
          webhookIds: requestBody.webhookIds
      - text: Unregister my app's webhooks with IDs {webhookIds}.
        slots:
          webhookIds: requestBody.webhookIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/webhook/failed'].get
  update:
    x-apievangelist-phrasing:
      intent: List recently failed webhook deliveries
      effect: read
      questions:
      - Which Jira webhooks failed to reach my app after all retries?
      - How long are failed webhook deliveries kept?
      instructions:
      - text: List failed Jira webhook deliveries to my app.
      - text: Show up to {maxResults} webhook failures after {after}.
        slots:
          maxResults: query.maxResults
          after: query.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/webhook/refresh'].put
  update:
    x-apievangelist-phrasing:
      intent: Extend the life of Jira webhooks
      effect: write
      questions:
      - Do Jira webhooks registered by API expire?
      - Can I keep my app's webhooks alive past 30 days?
      instructions:
      - text: Extend webhooks {webhookIds} for another 30 days.
        slots:
          webhookIds: requestBody.webhookIds
      - text: Refresh the expiry of Jira webhooks {webhookIds}.
        slots:
          webhookIds: requestBody.webhookIds
      method: generated
      generated: '2026-10-01'