Salesforce · Schema

Header

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
isRichText ['string', 'null']
messageSegments array
text string
View JSON Schema on GitHub

JSON Schema

salesforce-header-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "isRichText": {
      "type": "['string', 'null']",
      "example": "example_value"
    },
    "messageSegments": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "motif": {
            "type": "object",
            "properties": {
              "color": {
                "type": "string",
                "example": "example_value"
              },
              "largeIconUrl": {
                "type": "string",
                "example": "https://www.example.com"
              },
              "mediumIconUrl": {
                "type": "string",
                "example": "https://www.example.com"
              },
              "smallIconUrl": {
                "type": "string",
                "example": "https://www.example.com"
              },
              "svgIconUrl": {
                "type": "['string', 'null']",
                "example": "https://www.example.com"
              }
            },
            "required": [
              "color",
              "largeIconUrl",
              "mediumIconUrl",
              "smallIconUrl",
              "svgIconUrl"
            ]
          },
          "reference": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "example": "abc123"
              },
              "url": {
                "type": "string",
                "example": "https://www.example.com"
              }
            },
            "required": [
              "id",
              "url"
            ]
          },
          "text": {
            "type": "string",
            "example": "example_value"
          },
          "type": {
            "type": "string",
            "example": "example_value"
          }
        },
        "required": [
          "motif",
          "reference",
          "text",
          "type"
        ]
      }
    },
    "text": {
      "type": "string",
      "example": "example_value"
    }
  },
  "required": [
    "isRichText",
    "messageSegments",
    "text"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Header"
}