Atlassian Compass · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Compass REST Incoming Webhooks Rest Controller API

2 actions 2 updates phrasing extends openapi/atlassian-compass-incoming-webhooks-rest-controller-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Atlassian Compass's API. It is a proposal applied on top of the contract, not a document Atlassian Compass publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/compass/v1/webhooks/{webhookId}'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Compass REST Incoming Webhooks Rest Controller API
  version: 1.0.0
extends: openapi/atlassian-compass-incoming-webhooks-rest-controller-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: 1
- target: $.paths['/compass/v1/webhooks/{webhookId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an inbound Compass webhook
      effect: write
      questions:
      - Can a third-party tool call a Compass inbound webhook to create deployment events?
      - What URL does GitHub post to so Compass receives its webhook payloads?
      instructions:
      - text: Invoke inbound webhook {webhookId} with this payload.
        slots:
          webhookId: path.webhookId
      - text: Forward the GitHub deployment notification to Compass webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-09-26'