Azure DevOps · Schema

Consumer

A consumer that can receive service hook notifications

AgileCI/CDDevOpsProject ManagementVersion Control

Properties

Name	Type	Description
id	string	Unique identifier of the consumer
name	string	Display name of the consumer
description	string	Description of this consumer type
imageUrl	string	URL to the consumer's icon
informationUrl	string	Documentation URL for this consumer
actions	array	Available actions for this consumer
inputs	array	Configuration inputs for this consumer
url	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Consumer",
  "title": "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"
    }
  }
}