A widget is a container that can be used to display customized data coming from integrations at the right-hand sidebar of the ticket or user page. It contains a list of fields and values that come from integrations.

Widget properties

id

integer

ID of the widget.

context

string

The context to display this widget in.

Supported values are: ticket, customer, user.

The value user has been deprecated, please use customer instead.

created_datetime

ISO 8601 datetime

When the widget was created.

deactivated_datetime

ISO 8601 datetime

When the widget was deactivated.

integration_id

integer | null

ID of the integration that the widget's data is attached to. Only used for widgets attached to HTTP integrations. Widgets are the same for all Shopify integrations, but each HTTP integration needs a specific widget.

app_id

string | null

The ID of the 3rd party app that the widget's data is attached to. Used for customer external data widgets.

order

integer

Order of precedence of the widget. Widgets with lower order are shown first.

template

object

Template to render the data of the widget.

type

string

Type of data the widget is attached to.

updated_datetime

ISO 8601 datetime

When the widget was updated.

uri

string

URI of the widget.

Widget example object

{
  "id": 123,
  "context": "ticket",
  "created_datetime": "2020-12-01T13:00:00.123456",
  "deactivated_datetime": "2020-12-03T13:00:00.123456",
  "app_id": "60b9f144096cf92533e0a14d",
  "order": 3,
  "template": {
    "type": "wrapper",
    "widgets": [
      {
        "path": "account_info",
        "type": "card",
        "title": "Account Info",
        "widgets": [
          {
            "path": "account_id",
            "type": "text",
            "title": "Account ID"
          }
        ]
      }
    ]
  },
  "type": "http",
  "updated_datetime": "2020-12-02T13:00:00.123456"
}