Create a widget

post

https://{domain}.gorgias.com/api/widgets

Body Params

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.

context

string

enum

Defaults to ticket

The context to display this widget in.

Supported values are: ticket, customer, user.

The value <span style={{color: 'red'}}>user has been deprecated, please use customer instead.

Allowed:

deactivated_datetime

date-time | null

When the widget was deactivated.

integration_id

integer | null

≥ 0

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.

order

integer

≥ 0

Defaults to 0

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

template

object

required

Template to render the data of the widget.

type

string

enum

required

Type of data the widget is attached to.

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created widget.