Asana · Schema

Preview

A collection of rich text that will be displayed as a preview to another app. This is read-only except for a small group of whitelisted apps.

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow

Properties

Name	Type	Description
fallback	string	Some fallback text to display if unable to display the full preview.
footer	string	Text to display in the footer.
header	string	Text to display in the header.
header_link	string	Where the header will link to.
html_text	string	HTML formatted text for the body of the preview.
text	string	Text for the body of the preview.
title	string	Text to display as the title.
title_link	string	Where to title will link to.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Preview",
  "title": "Preview",
  "type": "object",
  "description": "A collection of rich text that will be displayed as a preview to another app.\n\nThis is read-only except for a small group of whitelisted apps.",
  "readOnly": true,
  "properties": {
    "fallback": {
      "description": "Some fallback text to display if unable to display the full preview.",
      "type": "string",
      "example": "Greg: Great! I like this idea.\\n\\nhttps//a_company.slack.com/archives/ABCDEFG/12345678"
    },
    "footer": {
      "description": "Text to display in the footer.",
      "type": "string",
      "example": "Mar 17, 2019 1:25 PM"
    },
    "header": {
      "description": "Text to display in the header.",
      "type": "string",
      "example": "Asana for Slack"
    },
    "header_link": {
      "description": "Where the header will link to.",
      "type": "string",
      "example": "https://asana.comn/apps/slack"
    },
    "html_text": {
      "description": "HTML formatted text for the body of the preview.",
      "type": "string",
      "example": "<body>Great! I like this idea.</body>"
    },
    "text": {
      "description": "Text for the body of the preview.",
      "type": "string",
      "example": "Great! I like this idea."
    },
    "title": {
      "description": "Text to display as the title.",
      "type": "string",
      "example": "Greg"
    },
    "title_link": {
      "description": "Where to title will link to.",
      "type": "string",
      "example": "https://asana.slack.com/archives/ABCDEFG/12345678"
    }
  }
}