Create Widget
gorgias_create_widgetCreate a widget to display data from third-party integrations in Gorgias ticket and customer sidebars.
Instructions
POST /api/widgets — Create a new widget to display customized data from integrations in the Gorgias ticket or customer sidebar.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Type of data the widget is attached to | |
| order | No | Order of precedence; widgets with lower order appear first (default: 0) | |
| app_id | No | ID of the 3rd party app. Used for type 'customer_external_data' widgets | |
| context | No | The UI context where this widget is displayed (default: 'ticket'). Note: 'user' is deprecated, use 'customer' | |
| template | Yes | Template to render the data of the widget | |
| integration_id | No | ID of the HTTP integration this widget is attached to. Only for type 'http' widgets | |
| deactivated_datetime | No | ISO 8601 datetime when the widget was deactivated. Set to deactivate on creation |