Views

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

Показывает пользователю модальное окно с формой в ответ на его действие. Метод вызывают токеном бота: события о нажатии кнопок приходят только ботам, от имени бота окно и открывается.

Открыть окно можно единственным способом — по trigger_id из события о нажатии кнопки. Один trigger_id открывает одно окно и живёт 3 секунды: у бота с вебхуком — с момента, когда Пачка передала нажатие, у бота с [Журналом событий](GET /webhooks/events) — с момента записи нажатия в журнал. Поэтому окно открывают первым делом, а всё остальное по событию делают уже после.

Заполненная форма приходит обратно событием view_submit: на исходящий вебхук, а если адрес не задан — в журнал. На вебхук отвечают прямо в ответе на него, и Пачка ждёт его 3 секунды. Событие из журнала закрывают методом [Ответ на отправку формы](POST /views/{view_id}/submit_response), на это есть 5 секунд. Не успели — пользователь увидит ошибку отправки.

post/views/open

Request

  • Base URL: https://api.pachca.com/api/shared/v1
  • URL: https://api.pachca.com/api/shared/v1/views/open
  • Auth: HTTP bearer

Request body

type'modal' required

Способ открытия представления

trigger_idstring required

Уникальный идентификатор события (полученный, например, в исходящем вебхуке о нажатии кнопки)

private_metadatastring

Необязательная строка, которая будет отправлена в ваше приложение при отправке пользователем заполненной формы. Используйте это поле, например, для передачи в формате JSON какой то дополнительной информации вместе с заполненной пользователем формой.

callback_idstring

Необязательный идентификатор для распознавания этого представления, который будет отправлен в ваше приложение при отправке пользователем заполненной формы. Используйте это поле, например, для понимания, какую форму должен был заполнить пользователь.

Example request

{
  "type": "modal",
  "trigger_id": "791a056b-006c-49dd-834b-c633fde52fe8",
  "private_metadata": "{\"timeoff_id\":4378}",
  "callback_id": "timeoff_request_form",
  "view": {
    "title": "Уведомление об отпуске",
    "close_text": "Закрыть",
    "submit_text": "Отправить заявку",
    "blocks": [
      {
        "type": "header",
        "text": "Основная информация"
      }
    ]
  }
}

Response

The request has succeeded and a new resource has been created as a result.

Changes

No recorded changes to this operation across all 1 revision of this API.