HomeOnboardingTask

Required access

read_home access scope

Task to be completed by new merchants during their onboarding period.

Show definition
# Task to be completed by new merchants during their onboarding period.
type HomeOnboardingTask {
  # List of buttons for the task.
  buttons: [HomeButton!]!

  # Status of the tasks completion.
  completed: Boolean!

  # Image representing the task.
  image(
    # Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
    maxWidth: Int

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

    # Converts image file type from SVG to PNG, or leaves as original SVG.
    contentType: HomeContentType = PNG
  ): Image!

  # Short hand representation of the task title.
  label: String!

  # Description of what the task is supposed to do.
  message: FormattedString!

  # Title for this task.
  title: FormattedString!
}

Fields

buttons   ([HomeButton!]!)

List of buttons for the task.

Required access

read_ access scope

completed   (Boolean!)

Status of the tasks completion.

Required access

read_ access scope

image   (Image!)

Image representing the task.

Required access

read_ access scope

Argument Type Default Description
contentType

HomeContentType

PNG

Converts image file type from SVG to PNG, or leaves as original SVG.

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.

label   (String!)

Short hand representation of the task title.

Required access

read_ access scope

message   (FormattedString!)

Description of what the task is supposed to do.

Required access

read_ access scope

title   (FormattedString!)

Title for this task.

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up