API Reference version 2

Create global dialog

PUT/v2/extension/dialog/{key}

Create a global dialog.

Dynamically created dialogs have the following restrictions:

  • You can only create 10 global dialogs
  • You cannot modify a dialog that was declared in the descriptor

Path parameters

Type Parameter Description Required?
string key

Unique key (in the context of the integration) to identify this dialog.

Valid length range: 1 - 40.

Required

Request body

Type Property Description Required?
string url

The url where the dialog content is hosted.

Required
string authentication

The authentication method for this dialog

Valid values: jwt, none.

Defaults to 'jwt'.

object options

Dialog options

string style

The dialog style (default is 'normal')

Valid values: normal, warning.

object hint

The dialog hint, displayed in the left side of the bottom bar

string i18n

The optional localization key, used to look up the localized value.

Valid length range: 1 - 40.

string value

The default text.

Valid length range: 1 - 100.

Required
object filter

If present, adds a filter box in the dialog header

object placeholder

The placeholder text for the filter box.

string i18n

The optional localization key, used to look up the localized value.

Valid length range: 1 - 40.

string value

The default text.

Valid length range: 1 - 100.

Required
object primaryAction

The primary action of the dialog, rendered as a primary button.

boolean enabled

Whether button is disabled or enabled (default 'true')

object name

The localizable name of the button

Required
string i18n

The optional localization key, used to look up the localized value.

Valid length range: 1 - 40.

string value

The default text.

Valid length range: 1 - 100.

Required
string key

A key that can be used to register an event listener. Default 'primary-action-selected' for the primary action, none for secondary actions

array secondaryActions

The secondary actions of the dialog, rendered as link buttons.

An array of the following objects.

boolean enabled

Whether button is disabled or enabled (default 'true')

object name

The localizable name of the button

Required
string i18n

The optional localization key, used to look up the localized value.

Valid length range: 1 - 40.

string value

The default text.

Valid length range: 1 - 100.

Required
string key

A key that can be used to register an event listener. Default 'primary-action-selected' for the primary action, none for secondary actions

obj | str size

The size of the dialog

object [size, object 1]

A custom dialog size. adjusted to fit the contents

Required
string width

The width of the dialog, either in pixels ('px') or as a percentage ('%').

Required
string height

The height of the dialog, either in pixels ('px') or as a percentage ('%').

Required
string key

Unique key (in the context of the integration) to identify this dialog.

Valid length range: 1 - 40.

Required
object title

The dialog title

Required
string i18n

The optional localization key, used to look up the localized value.

Valid length range: 1 - 40.

string value

The default text.

Valid length range: 1 - 100.

Required
201 application/json
Type Property Description Required?
str | int id

The unique identifier for the created entity

Required
object links

An object with the following properties.

Required
string self Required