Перейти к содержимому

Открытие представления

POST/views/open

Метод для открытия модального окна с представлением для пользователя.

Чтобы открыть модальное окно с представлением, ваше приложение должно иметь действительный, неистекший trigger_id.

Тело запроса

application/json
type
string
*
Способ открытия представления
Возможные значения
Пример:modal
trigger_id
string
*
Уникальный идентификатор события (полученный, например, в исходящем вебхуке о нажатии кнопки)
Пример:791a056b-006c-49dd-834b-c633fde52fe8
private_metadata
string
Необязательная строка, которая будет отправлена в ваше приложение при отправке пользователем заполненной формы. Используйте это поле, например, для передачи в формате JSON какой то дополнительной информации вместе с заполненной пользователем формой.
Пример:{"timeoff_id":4378}
Длина:
<= 3000 символов
callback_id
string
Необязательный идентификатор для распознавания этого представления, который будет отправлен в ваше приложение при отправке пользователем заполненной формы. Используйте это поле, например, для понимания, какую форму должен был заполнить пользователь.
Пример:timeoff_reguest_form
Длина:
<= 255 символов
view
object
*
Собранный объект представления
title
string
*
Заголовок представления
Пример:Уведомление об отпуске
Длина:
<= 24 символов
close_text
string
Текст кнопки закрытия представления
Пример:Закрыть
По умолчанию:
Отменить
Длина:
<= 24 символов
submit_text
string
Текст кнопки отправки формы
Пример:Отправить заявку
По умолчанию:
Отправить
Длина:
<= 24 символов
blocks[]
array of anys
*
Массив блоков представления
Количество:
<= 100 элементов
Union-тип для всех возможных блоков представления
ViewBlockHeaderobject
ViewBlockPlainTextobject
ViewBlockMarkdownobject
ViewBlockDividerobject
ViewBlockInputobject
ViewBlockSelectobject
ViewBlockRadioobject
ViewBlockCheckboxobject
ViewBlockDateobject
ViewBlockTimeobject
ViewBlockFileInputobject

Ответ

201Created
The request has succeeded and a new resource has been created as a result.
Открытие представления