Get widget metadata

Note: The path is a placeholder. The actual path is determined by the configuration of the app component.

Get the metadata from the app server to render a widget.


App components widget metadata request flow

Query Params
string
required

The URL of the URL attachment on the task (i.e., Jira issue, GitHub pull request)

string
required

The workspace GID this hook is coming from.

string
required

The task GID this hook is coming from.

string
required

The user GID this hook is coming from.

string
required

The attachment ID of the URL attachment.

string
required

The time (in ISO 8601 date format) when the request should expire.

Responses

Response body
object
string
required

The interface name and version of a distinct widget UI layout. A template is directly associated with a particular metadata schema.

summary_with_details_v0

object
required

The metadata (i.e., underlying definition) of a widget. metadata must exist alongside a template, and its schema must be specific to the value of that template.

string
required

The text to show in the title of the widget. Max length of 200 characters.

array
required

A list of fields showing data from external resources (i.e., an array of WidgetField objects). A widget must contain at least 1 field and no more than 5 fields.

Valid object schemas: WidgetField-DatetimeWithIcon, WidgetField-Pill, WidgetField-TextWithIcon.

fields*
string

The text to show under the title of the widget, next to "Open in {App Name}". If not provided, the resource_name from the app definition will be used as default.

string

The URL of the subicon next to the subtitle . If not provided, no icon will be shown.

object
required
Has additional fields
integer

The number of comments to display on the lower right corner of the widget. If not provided, no comment count will be shown

Language
URL
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.