Оформляйте карточки сообщений

Устройство карточки

Части карточки сверху вниз. Пропустите то, что вам не нужно: карточка из одного заголовка тоже подойдёт.

#github

Сообщение от GitHub• acme/web

Открыт pull request #212

Открыт

Более быстрый поиск в списке каналов

Поиск теперь запускается при каждом нажатии клавиши с задержкой 120 мс.

Автор

maya

Ревьюеры

dani, sam

10:03

+86-12

1. Шапка«Сообщение от» и имя: имя вебхука или, для ответа на команду, название вашего сообщества. Ответ может добавить badge, например репозиторий.
2. Заголовок и статусtitle, который становится ссылкой, если задан title_url, а рядом плашка status.
3. ПодзаголовокВторая строка жирным шрифтом, sub_title.
4. ОписаниеОсновной текст в markdown.
5. ПоляСтроки «название: значение» с кнопкой копирования.
6. Нижняя строкаВремя, а также добавленные и удалённые строки, если вы их передали.

{
  "message_container": {
    "type": "embed_message",
    "badge": "acme/web",
    "color": "purple",
    "title": "Pull request #212 opened",
    "title_url": "https://github.com/acme/web/pull/212",
    "status": { "label": "Open", "color": "green", "icon": "pull_request" },
    "sub_title": "Faster search in the channel list",
    "description": "Search now runs **per keystroke** with a 120 ms debounce.",
    "fields": [
      { "field": "Author", "value": "maya" },
      { "field": "Reviewers", "value": "dani, sam" }
    ],
    "additions": 86,
    "deletions": 12,
    "files_changed": 3
  }
}

Все поля

Они передаются в message_container. Карточке нужно описание или индикатор загрузки. Поля с пометкой «Ответы на команды» отбрасываются, если публиковать через вебхук.

Статус и статистика diff

Плашка статуса рассказывает суть ещё до того, как кто-то прочтёт текст. Она стоит рядом с заголовком, а если заголовка нет, то в нижней строке; статистика diff отображается рядом со временем. И то и другое работает в ответах на команды, и их использует встроенная интеграция GitHub. Вебхук их отбрасывает.

#github

Сообщение от GitHub• acme/web

Pull request #212 слит

Слит

11:20

Сообщение от CI• acme/web

Сборка на main упала

Ошибка

search.test.js: не прошли 2 из 212 тестов.

11:24

Сообщение от GitHub• acme/web

maya запушила в main

Коммит

11:31

+14-3

{
  "message_container": {
    "color": "red",
    "title": "Build failed on main",
    "status": { "label": "Failing", "color": "red" },
    "description": "`search.test.js`: 2 of 212 tests failed."
  }
}

Иконки

Соответствие, которое подходит для GitHub

Их использует встроенная интеграция GitHub; скопируйте их для своих инструментов.

Загрузка и размышления

Для всего, что занимает время, например ответа ИИ или долгой задачи, сначала опубликуйте карточку со спиннером, а потом замените её результатом. Индикатор загрузки работает и в вебхуках, и в ответах на команды. В ответе на команду рассуждения модели можно также поместить в thinking: вместо стены текста участники увидят переключатель Показать размышления.

#assistant

Сообщение от Assistant

Думаю…Читаю последние 50 сообщений

09:02

Сначала: индикатор загрузки

#assistant

Сообщение от Assistant

maya: когда стендап?

Стендап в 09:30, в #daily.

Показать размышления

Проверил закреплённые сообщения и повторяющееся событие в #daily.

09:02

Потом: ответ, размышления свёрнуты

{
  "message_container": {
    "type": "embed_message",
    "color": "blue",
    "loader": true,
    "loader_text": "Thinking…",
    "loader_sub_text": "Reading the last 50 messages"
  }
}

{
  "message_container": {
    "type": "embed_message",
    "color": "blue",
    "sub_title": "maya: when is the standup?",
    "description": "Standup is at **09:30**, in #daily.",
    "thinking": "Checked the pinned messages and the recurring event in #daily…"
  }
}

Чтобы заменить индикатор загрузки ответом, обновите сообщение новой карточкой без loader. Как это сделать, описано на странице обновлений вживую.

Длинные описания

Описание может занимать до 50 000 байт. После первых 1 000 участники видят начало и кнопку Показать больше, которая загружает остальное, так что длинный отчёт не заваливает канал.

Системные сообщения

Задайте "type": "system_message" для объявления, а не поста бота: окна обслуживания, изменения правил, всё, что говорит от имени самого сообщества. Такое сообщение принимает те же поля и кнопки.

{
  "message_container": {
    "type": "system_message",
    "color": "orange",
    "title": "Maintenance tonight",
    "description": "The build servers are down from 22:00 to 23:00."
  }
}

Цвета

Цвет кромки считывается на карточке быстрее всего. Всегда используйте один и тот же цвет для одного и того же рода новостей.