HomeTask

Version 2019-04 (latest)

A HomeTask represents an actionable task for the merchant to complete.

Required access

read_home access scope

Show definition
"""
A HomeTask represents an actionable task for the merchant to complete.
"""
type HomeTask {
  """
  A badge which contains a title and status type.
  """
  badge: HomeTaskBadge
  """
  Unique name used for analytics and identifying the task.
  """
  handle: String!
  """
  Image of the tasks icon.
  """
  icon(
    """
    Converts image file type from SVG to PNG, or leaves as original SVG.
    """
    contentType: HomeContentType = PNG
    """
    Image height in pixels between 1 and 2048. This argument is deprecated: Use
    maxHeight on Image.transformedSrc instead.
    """
    maxHeight: Int
    """
    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    """
    maxWidth: Int
  ): Image!
  """
  The ID of the task. A unique identifier used for analytics.
  """
  id: ID!
  """
  Title text for the task.
  """
  title: FormattedString!
  """
  URL to the location of the actionable task.
  """
  url: URL!
}

Fields

badge (HomeTaskBadge)

A badge which contains a title and status type.

handle (String!)

Unique name used for analytics and identifying the task.

icon (Image!)

Image of the tasks icon.

contentType ( HomeContentType )

Converts image file type from SVG to PNG, or leaves as original SVG.
Default value: true

maxHeight ( Int )

Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

maxWidth ( Int )

Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

id (ID!)

The ID of the task. A unique identifier used for analytics.

title (FormattedString!)

Title text for the task.

url (URL!)

URL to the location of the actionable task.

Sign up for a Partner account to get started.

Sign up