📘

Getting started

To get started, see widgets in the app components guide.

Schemas

WidgetMetadata

An object containing information about the widget. See get widget metadata.

{
  "metadata": {
    "error": "The resource cannot be accessed",
    "fields": [],
    "footer": {},
    "num_comments": 2,
    "subicon_url": "https://example-icon.png",
    "subtitle": "Custom App Story · Open in Custom App",
    "title": "Status"
  },
  "template": "summary_with_details_v0"
}

WidgetField-DatetimeWithIcon

A widget field that displays a timestamp and an optional icon.

{
  "datetime": "2012-02-22T02:06:58.147Z",
  "icon_url": "https://example-icon.png",
  "name": "Status",
  "type": "datetime_with_icon"
}

WidgetField-Pill

A widget field that displays custom text in a colored "pill" format.

{
  "color": "cool-gray",
  "name": "Status",
  "text": "In Progress",
  "type": "pill"
}

WidgetField-TextWithIcon

A widget field that displays custom text with an optional icon.

{
  "icon_url": "https://example-icon.png",
  "name": "Status",
  "text": "In Progress",
  "type": "text_with_icon"
}

WidgetFooter-Created

A widget footer that displays the timestamp of the resource's creation time.

{
  "created_at": "2012-02-22T02:06:58.147Z",
  "footer_type": "created"
}

WidgetFooter-CustomText

A widget footer that displays custom text and an optional icon.

{
  "footer_type": "custom_text",
  "icon_url": "https://example-icon.png",
  "text": "This is a custom footer message"
}

WidgetFooter-Updated

A widget footer that displays the timestamp of the resource's last updated time.

{
  "footer_type": "updated",
  "last_updated_at": "2012-02-22T02:06:58.147Z"
}

Error schemas

BadRequest

An error response object indicating a bad request (i.e., a status code of 400).

{
  "data": {
    "error": "Illegal or malformed request."
  }
}

Forbidden

An error response object indicating a forbidden request (i.e., a status code of 403).

{
  "data": {
    "error": "Access forbidden."
  }
}

InternalServerError

An error response object indicating a request that could not be found (i.e., a status code of 500).

{
  "data": {
    "error": "Internal server error."
  }
}

NotFound

An error response object indicating a request that could not be found (i.e., a status code of 404).

{
  "data": {
    "error": "Not found."
  }
}

Unauthorized

An error response object indicating a unauthorized request (i.e., a status code of 401).

{
  "data": {
    "error": "Authorization required."
  }
}