Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Repositories - Webhooks API

6 actions 6 updates phrasing extends openapi/atlassian-repositories-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['/repositories/{workspace}/{repo_slug}/hooks'].get

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

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

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

$.paths['/repositories/{workspace}/{repo_slug}/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 Repositories - Webhooks API
  version: 1.0.0
extends: openapi/atlassian-repositories-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['/repositories/{workspace}/{repo_slug}/hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's webhooks
      effect: read
      questions:
      - Which webhooks are installed on my Bitbucket repository?
      - Can I see every webhook subscription configured for a repo?
      instructions:
      - text: List the webhooks on {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show all webhook subscriptions for repository {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook to a repository
      effect: write
      questions:
      - How do I get notified at my URL whenever someone pushes to a repo?
      - Can I subscribe a webhook to pull request events on one repository?
      instructions:
      - text: Create a webhook on {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Add a new webhook subscription to repository {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/hooks/{uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one repository webhook
      effect: read
      questions:
      - Which events and URL does a particular repository webhook use?
      - Can I check whether a specific webhook is active?
      instructions:
      - text: Get webhook {uid} on {workspace}/{repo_slug}.
        slots:
          uid: path.uid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the configuration of repository webhook {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/hooks/{uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a repository webhook
      effect: write
      questions:
      - Can I change a webhook's URL, events or secret without recreating it?
      - Is it possible to deactivate a repository webhook temporarily?
      instructions:
      - text: Update webhook {uid} on {workspace}/{repo_slug}.
        slots:
          uid: path.uid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Change the URL, events or secret of repository webhook {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/hooks/{uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository webhook
      effect: destructive
      questions:
      - Can I remove a webhook I no longer use from a repository?
      - What's the call to unsubscribe a repository webhook permanently?
      instructions:
      - text: Delete webhook {uid} from {workspace}/{repo_slug}.
        slots:
          uid: path.uid
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove repository webhook {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-10-01'