# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect Webhooks API
  version: 1.0.0
extends: openapi/ios-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: 6
- target: $.paths['/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an App Store Connect webhook
      effect: write
      questions:
      - How do I register a webhook so App Store Connect notifies my server about events?
      - Can I subscribe a URL to App Store Connect event notifications?
      instructions:
      - text: Create a webhook with {webhook}.
        slots:
          webhook: requestBody.data
      - text: Register a notification endpoint for my app using {webhook}.
        slots:
          webhook: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's configuration
      effect: read
      questions:
      - What URL and event types is one of my webhooks set up for?
      - Is a given webhook currently enabled?
      instructions:
      - text: Get webhook {webhook}.
        slots:
          webhook: path.id
      - text: Fetch the configuration of webhook {webhook} and include {include}.
        slots:
          webhook: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop App Store Connect from sending events to a webhook permanently?
      - Can I remove a webhook I no longer need?
      instructions:
      - text: Delete webhook {webhook}.
        slots:
          webhook: path.id
      - text: Remove the notification endpoint {webhook}.
        slots:
          webhook: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change a webhook's URL, secret or event types?
      - What's the way to disable a webhook temporarily without deleting it?
      instructions:
      - text: Update webhook {webhook} with {changes}.
        slots:
          webhook: path.id
          changes: requestBody.data
      - text: Disable webhook {webhook} by setting {changes}.
        slots:
          webhook: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{id}/relationships/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List delivery IDs for a webhook
      effect: read
      questions:
      - Which delivery attempt IDs have been recorded for a webhook?
      - Can I get only the identifiers of a webhook's deliveries?
      instructions:
      - text: List only the delivery IDs for webhook {webhook}.
        slots:
          webhook: path.id
      - text: Return up to {limit} delivery identifiers for webhook {webhook}.
        slots:
          limit: query.limit
          webhook: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{id}/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: Review a webhook's delivery history
      effect: read
      questions:
      - Which webhook notifications failed to reach my server?
      - Can I see webhook deliveries sent within a specific date range?
      - How do I check the response my endpoint returned for each webhook delivery?
      instructions:
      - text: Show deliveries for webhook {webhook} with state {state}.
        slots:
          webhook: path.id
          state: query.filter[deliveryState]
      - text: List deliveries for webhook {webhook} created on or after {since} and before {until}.
        slots:
          webhook: path.id
          since: query.filter[createdDateGreaterThanOrEqualTo]
          until: query.filter[createdDateLessThan]
      method: generated
      generated: '2026-10-01'