Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Workspaces - Webhooks API

6 actions 6 updates phrasing extends openapi/atlassian-workspaces-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 6

$.info

$.paths['/workspaces/{workspace}/hooks'].get

$.paths['/workspaces/{workspace}/hooks'].post

$.paths['/workspaces/{workspace}/hooks/{uid}'].get

$.paths['/workspaces/{workspace}/hooks/{uid}'].put

$.paths['/workspaces/{workspace}/hooks/{uid}'].delete

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 Bitbucket Workspaces - Webhooks API
  version: 1.0.0
extends: openapi/atlassian-workspaces-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: 5
- target: $.paths['/workspaces/{workspace}/hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks on a workspace
      effect: read
      questions:
      - Which webhooks are installed on our Bitbucket workspace?
      - Can I audit the workspace-level webhook subscriptions?
      instructions:
      - text: List the webhooks installed on workspace {workspace}.
        slots:
          workspace: path.workspace
      - text: Show all workspace-level webhook subscriptions for {workspace}.
        slots:
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace webhook
      effect: write
      questions:
      - How do I get notified of events from every repository in a workspace?
      - Do workspace webhooks fire for all repos the workspace contains?
      instructions:
      - text: Create a webhook on workspace {workspace}.
        slots:
          workspace: path.workspace
      - text: Subscribe a new webhook to events from all repositories in {workspace}.
        slots:
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/hooks/{uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace webhook
      effect: read
      questions:
      - What URL and events is a specific workspace webhook subscribed to?
      - Is a given workspace webhook still active?
      instructions:
      - text: Get webhook {uid} on workspace {workspace}.
        slots:
          uid: path.uid
          workspace: path.workspace
      - text: Show the events and URL of workspace webhook {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/hooks/{uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a workspace webhook
      effect: write
      questions:
      - How do I change the URL or events of an existing workspace webhook?
      - Can I deactivate a workspace webhook or rotate its secret without deleting it?
      instructions:
      - text: Update webhook {uid} on workspace {workspace}.
        slots:
          uid: path.uid
          workspace: path.workspace
      - text: Change the events or secret on workspace webhook {uid} in {workspace}.
        slots:
          uid: path.uid
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/hooks/{uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace webhook
      effect: destructive
      questions:
      - How do I stop a workspace webhook from firing permanently?
      - Can I remove a webhook subscription from the whole workspace?
      instructions:
      - text: Delete webhook {uid} from workspace {workspace}.
        slots:
          uid: path.uid
          workspace: path.workspace
      - text: Remove the workspace webhook subscription {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-10-01'