# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure DevOps Service Hooks Subscriptions API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-subscriptions-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: 5
- target: $.paths['/hooks/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List service hook subscriptions
      effect: read
      questions:
      - What service hooks are set up in my Azure DevOps organization?
      - Can I list only the subscriptions for one event type or consumer?
      instructions:
      - text: List all service hook subscriptions.
      - text: List subscriptions for event type {eventType} from publisher {publisherId}.
        slots:
          eventType: query.eventType
          publisherId: query.publisherId
      - text: Show subscriptions that deliver to consumer {consumerId}.
        slots:
          consumerId: query.consumerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service hook subscription
      effect: write
      questions:
      - How do I send a webhook to my endpoint whenever code is pushed?
      - Which inputs do I need to subscribe a consumer to an event?
      instructions:
      - text: Subscribe {consumerId} action {consumerActionId} to {eventType} from {publisherId} with inputs {publisherInputs} and {consumerInputs}.
        slots:
          consumerId: requestBody.consumerId
          consumerActionId: requestBody.consumerActionId
          eventType: requestBody.eventType
          publisherId: requestBody.publisherId
          publisherInputs: requestBody.publisherInputs
          consumerInputs: requestBody.consumerInputs
      - text: Create a service hook for {eventType} events delivered to {consumerInputs}.
        slots:
          eventType: requestBody.eventType
          consumerInputs: requestBody.consumerInputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/subscriptions/{subscriptionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service hook subscription
      effect: read
      questions:
      - What endpoint and filters does a given service hook use?
      - Is a particular subscription enabled, and what event does it listen for?
      instructions:
      - text: Show service hook subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Get the consumer settings of subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/subscriptions/{subscriptionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service hook subscription
      effect: destructive
      questions:
      - How do I stop a service hook from sending notifications?
      - Is deleting a subscription permanent?
      instructions:
      - text: Delete service hook subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Remove subscription {subscriptionId} so its endpoint stops getting events.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/subscriptions/{subscriptionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service hook subscription
      effect: write
      questions:
      - Can I change the URL an existing service hook posts to?
      - What must I resend when editing a subscription's filters?
      instructions:
      - text: 'Update subscription {subscriptionId}: {eventType} from {publisherId} to {consumerId} action {consumerActionId}, inputs {publisherInputs} and {consumerInputs}.'
        slots:
          subscriptionId: path.subscriptionId
          eventType: requestBody.eventType
          publisherId: requestBody.publisherId
          consumerId: requestBody.consumerId
          consumerActionId: requestBody.consumerActionId
          publisherInputs: requestBody.publisherInputs
          consumerInputs: requestBody.consumerInputs
      - text: Point existing subscription {subscriptionId} at new consumer inputs {consumerInputs}.
        slots:
          subscriptionId: path.subscriptionId
          consumerInputs: requestBody.consumerInputs
      method: generated
      generated: '2026-09-26'