API Reference

Create a widget

post
https://{domain}.gorgias.com/api/widgets
Body Params
string
enum
Defaults to ticket

The context to display this widget in.

Allowed:
date-time | null

When the widget was deactivated.

int32 | 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.

int32
≥ 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.

string
enum
required

Type of data the widget is attached to.

Response

Updated 7 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago