adaptive-card.json

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "id": "http://adaptivecards.io/schemas/adaptive-card.json",
  "type": "object",
  "title": "Adaptive Card schema",
  "oneOf": [
    {
      "$ref": "#/definitions/AdaptiveCard"
    }
  ],
  "definitions": {
    "Action": {
      "anyOf": [
        {
          "$ref": "#/definitions/Action.Submit"
        },
        {
          "$ref": "#/definitions/Action.ShowCard"
        },
        {
          "$ref": "#/definitions/Action.Http"
        },
        {
          "$ref": "#/definitions/Action.OpenUrl"
        }
      ]
    },
    "Action.Http": {
      "title": "Http Action",
      "additionalProperties": false,
      "description": "Action.Http represents the properties needed to do an Http request. All input properties are available for use via data binding. Properties can be data bound to the Uri and Body properties, allowing you to send a request to an arbitrary url.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Action.Http"
          ]
        },
        "body": {
          "type": "string",
          "title": "content to post (can have binding information)"
        },
        "headers": {
          "type": "object",
          "title": "Object which represents headers Example: { \"content-type\":\"application/json\" }"
        },
        "method": {
          "type": "string",
          "enum": [
            "POST",
            "PUT",
            "DELETE",
            "GET"
          ],
          "title": "Http method (Default: POST)"
        },
        "title": {
          "type": "string",
          "title": "Label for button or link that represents this action"
        },
        "url": {
          "type": "string",
          "title": "url to use (can have binding information)"
        }
      },
      "required": [
        "type",
        "url"
      ],
      "type": "object"
    },
    "Action.OpenUrl": {
      "additionalProperties": false,
      "title": "When Action.OpenUrl is invoked it will show the given url, either by launching it to an external web browser or showing in-situ with embedded web browser.",
      "properties": {
        "title": {
          "type": "string",
          "title": "Label for button or link that represents this action"
        },
        "type": {
          "type": "string",
          "enum": [
            "Action.OpenUrl"
          ]
        },
        "url": {
          "type": "string",
          "title": "Default (browser) url to use"
        }
      },
      "required": [
        "type",
        "url"
      ],
      "type": "object"
    },
    "Action.ShowCard": {
      "additionalProperties": false,
      "title": "Action.ShowCard defines an inline AdaptiveCard which is shown to the user when it is clicked.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Action.ShowCard"
          ]
        },
        "title": {
          "type": "string",
          "title": "Label for button or link that represents this action"
        }
      },
      "required": [
        "type",
        "card"
      ],
      "type": "object"
    },
    "Action.Submit": {
      "additionalProperties": false,
      "title": "Submit action gathers up input fields, merges with optional data field and generates event to client asking for data to be submitted. It is up to the client to determine how that data is processed. For example: With BotFramework bots the client would send an activity through the messaging medium to the bot.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Action.Submit"
          ]
        },
        "title": {
          "type": "string",
          "title": "Label for button or link that represents this action"
        },
        "data": {
          "type": "object",
          "title": "initial data that input fields will be combined with. This is essentially 'hidden' properties"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "Actions": {
      "additionalItems": true,
      "items": {
        "$ref": "#/definitions/Action"
      },
      "type": "array"
    },
    "AdaptiveCard": {
      "additionalProperties": false,
      "properties": {
        "actions": {
          "$ref": "#/definitions/Actions"
        },
        "body": {
          "$ref": "#/definitions/CardElements"
        },
        "title": {
          "type": "string",
          "title": "Title/caption for the adaptive card."
        },
        "type": {
          "type": "string",
          "enum": [
            "AdaptiveCard"
          ]
        },
        "version": {
          "type": "string",
          "title": "version of schema that this card was authored "
        },
        "minVersion": {
          "type": "string",
          "title": "if a client doesn't support the minVersion the card should be rejected.  If it does, then the elements that are not supported are safe to ignore"
        },
        "fallbackText": {
          "type": "string",
          "title": "if a client is not able to show the card, show fallbackText to the user. This can be in markdown format. "
        }
      },
      "required": [
        "type",
        "version"
      ],
      "type": "object"
    },
    "CardElement": {
      "oneOf": [
        {
          "$ref": "#/definitions/TextBlock"
        },
        {
          "$ref": "#/definitions/Image"
        },
        {
          "$ref": "#/definitions/ColumnSet"
        },
        {
          "$ref": "#/definitions/FactSet"
        },
        {
          "$ref": "#/definitions/ImageSet"
        },
        {
          "$ref": "#/definitions/Input.Text"
        },
        {
          "$ref": "#/definitions/Input.Number"
        },
        {
          "$ref": "#/definitions/Input.Date"
        },
        {
          "$ref": "#/definitions/Input.Time"
        },
        {
          "$ref": "#/definitions/Input.Toggle"
        },
        {
          "$ref": "#/definitions/Input.ChoiceSet"
        }
      ]
    },
    "CardElements": {
      "additionalItems": true,
      "items": {
        "$ref": "#/definitions/CardElement"
      },
      "type": "array"
    },
    "Choice": {
      "additionalProperties": false,
      "properties": {
        "title": {
          "type": "string",
          "title": "The text for a choice"
        },
        "isSelected": {
          "type": "boolean",
          "title": "is the choice selected"
        },
        "value": {
          "type": "string",
          "title": "the raw value for the choice"
        }
      },
      "required": [
        "title",
        "value"
      ],
      "type": "object"
    },
    "ChoiceInputStyle": {
      "type": "string",
      "title": "Style hint for Input.ChoiceSet",
      "enum": [
        "compact",
        "expanded"
      ]
    },
    "Column": {
      "additionalProperties": false,
      "title": "Defines a container that is part of a ColumnSet",
      "properties": {
        "items": {
          "$ref": "#/definitions/CardElements"
        },
        "selectAction": {
          "$ref": "#/definitions/Action"
        },
        "size": {
          "type": [
            "string",
            "number"
          ],
          "title": "auto, stretch, or a number representing relative width of the column in the column group"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "type": "string",
          "title": "Must be Column",
          "enum": [
            "Column"
          ]
        }
      },
      "required": [
        "type",
        "items"
      ],
      "type": "object"
    },
    "ColumnSet": {
      "additionalProperties": false,
      "title": "The column group Item adds the ability to have a set of Column objects",
      "properties": {
        "columns": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Column"
          }
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "type": "string",
          "title": "Must be ColumnSet",
          "enum": [
            "ColumnSet"
          ]
        }
      },
      "required": [
        "type",
        "columns"
      ],
      "type": "object"
    },
    "Container": {
      "additionalProperties": false,
      "title": "The Container is a CardItem which contains a list of CardItems that are logically grouped",
      "properties": {
        "actions": {
          "$ref": "#/definitions/Actions"
        },
        "items": {
          "$ref": "#/definitions/CardElements"
        },
        "selectAction": {
          "$ref": "#/definitions/Action"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "style": {
          "type": "string",
          "title": "Style hint for Container",
          "enum": [
            "normal",
            "emphasis"
          ]
        },
        "type": {
          "type": "string",
          "title": "Must be Container",
          "enum": [
            "Container"
          ]
        }
      },
      "required": [
        "type",
        "items"
      ],
      "type": "object"
    },
    "Fact": {
      "additionalProperties": false,
      "properties": {
        "title": {
          "type": "string"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "title",
        "value"
      ],
      "type": "object"
    },
    "FactSet": {
      "additionalProperties": false,
      "title": "The FactSet Item makes it simple to display a series of facts (e.g. name/value pairs) in a tabular form.",
      "properties": {
        "facts": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Fact"
          }
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "type": "string",
          "title": "Must be FactSet",
          "enum": [
            "FactSet"
          ]
        }
      },
      "required": [
        "type",
        "facts"
      ],
      "type": "object"
    },
    "HorizontalAlignment": {
      "type": "string",
      "title": "Controls how Items are horizontally positioned within their container.",
      "enum": [
        "left",
        "center",
        "right"
      ]
    },
    "Image": {
      "additionalProperties": false,
      "title": "The Image Item allows for the inclusion of images in an Adaptive Card.",
      "properties": {
        "altText": {
          "type": "string",
          "title": "Alternate text for the image for accessibility"
        },
        "horizontalAlignment": {
          "$ref": "#/definitions/HorizontalAlignment"
        },
        "selectAction": {
          "$ref": "#/definitions/Action"
        },
        "size": {
          "$ref": "#/definitions/ImageSize"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "style": {
          "$ref": "#/definitions/ImageStyle"
        },
        "type": {
          "type": "string",
          "title": "Must be Image",
          "enum": [
            "Image"
          ]
        },
        "url": {
          "type": "string",
          "title": "The URL to the image."
        }
      },
      "required": [
        "type",
        "url"
      ],
      "type": "object"
    },
    "ImageSet": {
      "additionalProperties": false,
      "title": "The ImageSet allows for the inclusion of a collection images like a photogallery.",
      "properties": {
        "images": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Image"
          }
        },
        "imageSize": {
          "$ref": "#/definitions/ImageSize"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "type": "string",
          "title": "Must be ImageSet",
          "enum": [
            "ImageSet"
          ]
        }
      },
      "required": [
        "type",
        "images"
      ],
      "type": "object"
    },
    "ImageSize": {
      "type": "string",
      "title": "Controls the horizontal size (width) of Item. ",
      "enum": [
        "auto",
        "stretch",
        "small",
        "medium",
        "large"
      ]
    },
    "ImageStyle": {
      "type": "string",
      "title": "Controls the way Image Items are displayed",
      "enum": [
        "normal",
        "person"
      ]
    },
    "Input.ChoiceSet": {
      "additionalProperties": false,
      "title": "Shows an array of Choice objects",
      "properties": {
        "choices": {
          "type": "array",
          "title": "the choice options",
          "items": {
            "$ref": "#/definitions/Choice"
          }
        },
        "id": {
          "type": "string",
          "title": "Id for the value (will be used to identify collected input when SUBMIT is clicked)"
        },
        "isMultiSelect": {
          "type": "boolean",
          "title": "allow multiple choices to be selected (Default=false)"
        },
        "style": {
          "$ref": "#/definitions/ChoiceInputStyle"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "title": "Must be Input.ChoiceInput",
          "enum": [
            "Input.ChoiceSet"
          ],
          "type": "string"
        }
      },
      "required": [
        "type",
        "id",
        "choices"
      ],
      "type": "object"
    },
    "Input.Date": {
      "additionalProperties": false,
      "title": "Input.Date collects Date from the user,",
      "properties": {
        "id": {
          "type": "string",
          "title": "Id for the value (will be used to identify collected input when SUBMIT is clicked)"
        },
        "max": {
          "type": "string",
          "title": "hint of maximum value expressed in iso-8601 format (may be ignored by some clients)"
        },
        "min": {
          "type": "string",
          "title": "hint of minimum value expressed in iso-8601 format (may be ignored by some clients)"
        },
        "placeholder": {
          "type": "string",
          "title": "Title title of the input desired"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "type": "string",
          "title": "The type must be Input.Date",
          "enum": [
            "Input.Date"
          ]
        },
        "value": {
          "type": "string",
          "title": "The initial value for a field expressed in iso-8601 format"
        }
      },
      "required": [
        "type",
        "id"
      ],
      "type": "object"
    },
    "Input.Number": {
      "additionalProperties": false,
      "title": "Input.Number collects number from the user,",
      "properties": {
        "id": {
          "type": "string",
          "title": "Id for the value (will be used to identify collected input when SUBMIT is clicked)"
        },
        "max": {
          "type": "number",
          "title": "hint of maximum value (may be ignored by some clients)"
        },
        "min": {
          "type": "number",
          "title": "hint of minimum value (may be ignored by some clients)"
        },
        "placeholder": {
          "type": "string",
          "title": "Title title of the input desired"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "type": "string",
          "title": "The type must be Input.Number",
          "enum": [
            "Input.Number"
          ]
        },
        "value": {
          "type": "number",
          "title": "The initial value for a field"
        }
      },
      "required": [
        "type",
        "id"
      ],
      "type": "object"
    },
    "Input.Text": {
      "additionalProperties": false,
      "title": "Input.Text collects text from the user,",
      "properties": {
        "id": {
          "type": "string",
          "title": "Id for the value (will be used to identify collected input when SUBMIT is clicked)"
        },
        "isMultiline": {
          "type": "boolean",
          "title": "Do you want to allow multiple lines of input"
        },
        "maxLength": {
          "type": "number",
          "title": "hint of maximum length characters to collect (may be ignored by some clients)"
        },
        "placeholder": {
          "type": "string",
          "title": "Title title of the input desired"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "style": {
          "$ref": "#/definitions/TextInputStyle"
        },
        "type": {
          "type": "string",
          "title": "Input.Text",
          "enum": [
            "Input.Text"
          ]
        },
        "value": {
          "type": "string",
          "title": "The initial value for a field"
        }
      },
      "required": [
        "type",
        "id"
      ],
      "type": "object"
    },
    "Input.Time": {
      "additionalProperties": false,
      "title": "Input.Time collects Time from the user,",
      "properties": {
        "id": {
          "type": "string",
          "title": "Id for the value (will be used to identify collected input when SUBMIT is clicked)"
        },
        "max": {
          "type": "string",
          "title": "hint of maximum value (may be ignored by some clients)"
        },
        "min": {
          "type": "string",
          "title": "hint of minimum value (may be ignored by some clients)"
        },
        "placeholder": {
          "type": "string",
          "title": "Title title of the input desired"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "type": {
          "type": "string",
          "title": "The type must be Input.Time",
          "enum": [
            "Input.Time"
          ]
        },
        "value": {
          "type": "string",
          "title": "The initial value for a field expressed in iso-8601 format"
        }
      },
      "required": [
        "type",
        "id"
      ],
      "type": "object"
    },
    "Input.Toggle": {
      "additionalProperties": false,
      "title": "Input.Toggle collects text from the user,",
      "properties": {
        "id": {
          "type": "string",
          "title": "Id for the value (will be used to identify collected input when SUBMIT is clicked)"
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "title": {
          "type": "string",
          "title": "Title for the toggle"
        },
        "type": {
          "type": "string",
          "title": "Input.Toggle",
          "enum": [
            "Input.Toggle"
          ]
        },
        "value": {
          "type": "string",
          "title": "The current selected value (default:false)"
        },
        "valueOff": {
          "type": "string",
          "title": "The value when toggle is off (default:false)"
        },
        "valueOn": {
          "type": "string",
          "title": "The value when toggle is on (default:true)"
        }
      },
      "required": [
        "type",
        "id",
        "title"
      ],
      "type": "object"
    },
    "Speak": {
      "type": "string",
      "title": "Specifies what should be spoken for this entire Item. This is simple text or SSML fragment"
    },
    "TextBlock": {
      "additionalProperties": false,
      "title": "The TextBlock Item allows for the inclusion of text, with various font sizes, weight and color, in Adaptive Cards.",
      "properties": {
        "color": {
          "type": "string",
          "title": "Controls the color of TextBlock Items.",
          "enum": [
            "default",
            "dark",
            "light",
            "accent",
            "good",
            "warning",
            "attention"
          ]
        },
        "horizontalAlignment": {
          "$ref": "#/definitions/HorizontalAlignment"
        },
        "isSubtle": {
          "type": "boolean",
          "title": "Indicates whether the color of the text should be slightly toned down to appear less prominent"
        },
        "maxLines": {
          "type": "number",
          "title": "When Wrap is true, you can specify the maximum number of lines to allow the textBlock to use."
        },
        "size": {
          "type": "string",
          "title": "controls size of the text.",
          "enum": [
            "small",
            "normal",
            "medium",
            "large",
            "extraLarge"
          ]
        },
        "speak": {
          "$ref": "#/definitions/Speak"
        },
        "separation": {
          "$ref": "#/definitions/SeparationStyle"
        },
        "text": {
          "type": "string",
          "title": "The actual text to display"
        },
        "type": {
          "type": "string",
          "title": "Must be TextBlock",
          "enum": [
            "TextBlock"
          ]
        },
        "weight": {
          "title": "Controls the weight of TextBlock Items",
          "enum": [
            "lighter",
            "normal",
            "bolder"
          ],
          "type": "string"
        },
        "wrap": {
          "type": "boolean",
          "title": "True if be is allowed to wrap"
        }
      },
      "required": [
        "type",
        "text"
      ],
      "type": "object"
    },
    "SeparationStyle": {
      "type": "string",
      "title": "Controls how Items are rendered relative to previous elements.",
      "enum": [
        "default",
        "none",
        "strong"
      ]
    },
    "TextInputStyle": {
      "type": "string",
      "title": "Style hint for Input.Text.",
      "enum": [
        "text",
        "tel",
        "url",
        "email"
      ]
    }
  }
}