API Reference
App directoryDocsForumMy apps

Get widget metadata

get
https://{siteUrl}/widget_metadata_url_path_placeholder

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

Updated 6 months ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago