GET:web-widgets/{id}

Response

Web Widget

<web-widget id="{id}" type="{type}" date="{date}" active="{active}" href="https://{hostname}/@api/deki/web-widgets/{id}">
    
    <!-- some web widgets rely on embedding child web widgets to provide a complete user experience -->
    <web-widgets count="{count}">
        {web-widget}
        ...
    </web-widgets>
    <name>{name}</name>
    <arguments>
        <{argument}>{value}</{argument}>
        ...
    </arguments>
    <host>{host}</host>
    <token>{token}</token>
    <code id="{embedid}" format="base64">{code}</code>
</web-widget>
Name Type Description
{hostname} string The Expert site hostname
{id} int The web widget numeric id
{type} string The web widget type (search, salesforce, zendesk, etc.)
{date} datetime ISO 8601 representation of the web widget's creation timestamp
{active} bool Is the web widget active or deactivated (unavailable to embed)?
{name} string The web widget's use case name or description
{argument} xml A configuration setting specific to the web widget type
{value} mixed The value of a configuration setting
{host} string The allowed browser CORS hostname pattern
{token} string A unique public key to allow Expert API access
{embedid} string A unique embed code id to identify where the web widget has been embedded
{code} string Base64 representation of the web widget's HTML embed code
{web-widget} Web Widget A child web widget, when necessary to provide a complete user experience
{count} int The total count of child web widgets