Azure DevOps Consumers API

openapi: 3.2.0
info:
  title: Azure DevOps Service Hooks Consumers API
  description: REST API for managing service hook subscriptions, publishers, and consumers in Azure DevOps. Service hooks enable event-driven integrations by delivering notifications to external services (webhooks, Azure Service Bus, Teams, Slack, etc.) when Azure DevOps events occur such as work item changes, build completions, and pull request updates.
  version: '7.1'
  contact:
    name: Microsoft Azure DevOps
    url: https://learn.microsoft.com/en-us/rest/api/azure/devops/hooks/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://dev.azure.com/{organization}/_apis
  description: Azure DevOps Service Hooks API (organization-level, no project scope)
  variables:
    organization:
      description: Azure DevOps organization name or ID
      default: myorganization
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Consumers
  description: Operations for listing consumers (webhook, service bus, etc.)
paths:
  /hooks/consumers:
    get:
      operationId: consumers_list
      summary: Azure DevOps List consumers
      description: Returns a list of all available consumers that can receive service hook notifications. Consumers include webhooks (httpRequest), Azure Service Bus, Azure Storage, Microsoft Teams, and other integration targets.
      tags:
      - Consumers
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: List of consumers returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Consumer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    ConsumerAction:
      type: object
      description: An action available in a consumer
      properties:
        id:
          type: string
          description: Action identifier
          example: httpRequest
        name:
          type: string
          description: Action display name
          example: Send a generic HTTP request with a JSON payload
        description:
          type: string
          description: Description of what this action does
        consumerId:
          type: string
          description: Parent consumer ID
        inputs:
          type: array
          description: Input parameters required for this action
          items:
            $ref: '#/components/schemas/InputDescriptor'
        url:
          type: string
          format: uri
    ApiError:
      type: object
      description: Error response from the Azure DevOps API
      properties:
        id:
          type: string
          format: uuid
        message:
          type: string
        typeName:
          type: string
        typeKey:
          type: string
        errorCode:
          type: integer
        eventId:
          type: integer
    InputDescriptor:
      type: object
      description: Descriptor for a configurable input parameter
      properties:
        id:
          type: string
          description: Input identifier
        name:
          type: string
          description: Display name
        description:
          type: string
          description: Help text
        inputMode:
          type: string
          description: How the input is presented in UI
          enum:
          - none
          - textBox
          - passwordBox
          - combo
          - radioButtons
          - checkBox
          - textArea
        isConfidential:
          type: boolean
          description: Whether the value is treated as a secret
        isRequired:
          type: boolean
          description: Whether this input is required
        values:
          type: object
          description: Allowed values for combo/radio inputs
          properties:
            defaultValue:
              type: string
            possibleValues:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                  displayValue:
                    type: string
        validation:
          type: object
          description: Validation rules for this input
          properties:
            dataType:
              type: string
              enum:
              - none
              - string
              - number
              - boolean
              - guid
              - uri
            isRequired:
              type: boolean
            pattern:
              type: string
              description: Regex pattern for validation
            patternMismatchErrorMessage:
              type: string
            minLength:
              type: integer
            maxLength:
              type: integer
    Consumer:
      type: object
      description: A consumer that can receive service hook notifications
      properties:
        id:
          type: string
          description: Unique identifier of the consumer
          example: webHooks
        name:
          type: string
          description: Display name of the consumer
          example: Web Hooks
        description:
          type: string
          description: Description of this consumer type
        imageUrl:
          type: string
          format: uri
          description: URL to the consumer's icon
        informationUrl:
          type: string
          format: uri
          description: Documentation URL for this consumer
        actions:
          type: array
          description: Available actions for this consumer
          items:
            $ref: '#/components/schemas/ConsumerAction'
        inputs:
          type: array
          description: Configuration inputs for this consumer
          items:
            $ref: '#/components/schemas/InputDescriptor'
        url:
          type: string
          format: uri
  responses:
    Unauthorized:
      description: Unauthorized - missing or invalid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Forbidden - insufficient permissions to perform this operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  parameters:
    ApiVersion:
      name: api-version
      in: query
      required: true
      description: Azure DevOps REST API version. Use 7.1 for the latest stable version.
      schema:
        type: string
        default: '7.1'
        enum:
        - '7.1'
        - '7.0'
        - '6.0'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Azure AD OAuth 2.0 bearer token
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication using a Personal Access Token (PAT). Use any string as the username and the PAT as the password, then base64-encode the result.