ASasana
Widgets

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. <br> <br> <a href="https://d3ki9tyy5l5ruj.cloudfront.net/obj/92841480867031372af8983f2906d26fbff6a2cc/ac-widget-metadata.png"> <img src="https://d3ki9tyy5l5ruj.cloudfront.net/obj/92841480867031372af8983f2906d26fbff6a2cc/ac-widget-metadata.png" alt="App components widget metadata request flow"/> </a>

get/widget_metadata_url_path_placeholder

Request

  • Base URL
    {siteUrl}
  • URL
    {siteUrl}/widget_metadata_url_path_placeholder
  • Auth
    none declared

Response

Successfully retrieved the metadata for a single widget.

template'summary_with_details_v0' required

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

Example response

{
  "template": "summary_with_details_v0",
  "metadata": {
    "title": "Status",
    "subtitle": "Custom App Story · Open in Custom App",
    "subicon_url": "https://example-icon.png",
    "num_comments": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.