Для разработчиков

Настройка и типы событий

Все настройки исходящего вебхука собраны на вкладке Исходящий Webhook в настройках бота.

Вкладка Исходящий Webhook в настройках бота

Общие настройки

  • Webhook URL — адрес, на который Пачка отправляет события
  • Signing secret — секрет для проверки подписи запроса. Подробнее — в разделе Безопасность и обработчик
  • Сохранять историю событий — бот сохраняет все исходящие вебхуки в очередь, и их можно получить через API. Подробнее — в разделе Поллинг
  • Игнорировать свои сообщения — не получать вебхуки о сообщениях, отправленных самим ботом. Предотвращает зацикливание, когда бот реагирует на собственные сообщения. Нажатия кнопок обрабатываются всегда, вне зависимости от этой настройки

Сообщения

В настройках доступны два отдельных пункта:

  • Новые сообщения — создание сообщений в чатах, где состоит бот, и в тредах этих чатов
  • Редактирование и удаление сообщений — изменение текста, файлов или удаление сообщений в чатах, где состоит бот, и в тредах этих чатов

Для новых сообщений доступны два режима отслеживания:

  • О любых сообщениях — все новые сообщения, включая треды
  • Сообщения, начинающиеся с команд — только сообщения, начинающиеся с указанных команд (например, /help, /deploy). Команды начинаются с / и пишутся на английском. Полезно, если вы не хотите получать поток событий, а вам нужно вызвать сценарий только по требованию пользователя
MessageWebhookPayloadobject

Реакции

Вебхук отправляется при добавлении или удалении реакции на сообщение в чате, где состоит бот.

ReactionWebhookPayloadobject

Нажатие кнопок

Вебхук отправляется при нажатии Data-кнопки в сообщении от бота. После получения вы можете PUTотредактировать сообщение — например, изменить или удалить кнопки — или POSTотправить новое как ответ пользователю. Подробнее — в разделе Кнопки в сообщениях.

ButtonWebhookPayloadobject

Заполнение формы

Вебхук отправляется при отправке пользователем заполненной формы (представления). Подробнее об обработке результатов — в разделе Обработка форм.

Поле chat_id фиксируется в момент открытия формы (нажатия кнопки), а не её отправки — если форма провисела открытой длительное время, поле всё равно ссылается на чат с кнопкой. Для форм, открытых до выкатки этого изменения, chat_id может приходить как null, потому что чат не был зафиксирован при открытии.
ViewSubmitWebhookPayloadobject

Изменение участников чатов

Вебхук отправляется при изменении состава участников чатов, где состоит бот, и в тредах этих чатов.

ChatMemberWebhookPayloadobject

Изменение участников пространства

Вебхук отправляется при добавлении, удалении или приостановке участников пространства. Не требует добавления бота в чат.

CompanyMemberWebhookPayloadobject

Отправка ссылок

Вебхук отправляется при появлении ссылки на один из доменов, указанных в настройках Unfurl-бота. Для получения таких событий необходимо создать специального Unfurl-бота. После получения вы можете воспользоваться методом POSTUnfurl (разворачивание ссылок) и создать предпросмотр ссылки в сообщении. Подробнее — в разделе Разворачивание ссылок.

LinkSharedWebhookPayloadobject