Оформлюйте картки повідомлень

Будова картки

Частини картки згори донизу. Пропустіть те, що вам не потрібно: картка лише із заголовком теж підходить.

#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 зробила push у 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."
  }
}

Кольори

Колір краю є найшвидшим сигналом на картці. Щоразу використовуйте той самий колір для того самого виду новин.