Projektuj karty wiadomości

Budowa karty

Części karty, od góry do dołu. Pomiń to, czego nie potrzebujesz: karta z samym tytułem też jest w porządku.

#github

Message from GitHub• acme/web

Otwarto pull request #212

Open

Szybsze wyszukiwanie na liście kanałów

Wyszukiwanie działa teraz przy każdym naciśnięciu klawisza, z debounce 120 ms.

Autor

maya

Recenzenci

dani, sam

10:03

+86-12

1. Nagłówek„Message from” i nazwa: nazwa webhooka albo, przy odpowiedzi na komendę, nazwa twojej społeczności. Odpowiedź może dodać badge, np. repozytorium.
2. Tytuł i statustitle, który staje się linkiem, gdy ustawisz title_url, z pigułką status obok.
3. PodtytułDruga pogrubiona linia, sub_title.
4. OpisTreść, w markdownie.
5. PolaWiersze z etykietą i wartością, z przyciskiem kopiowania.
6. StopkaGodzina oraz dodane i usunięte linie, jeśli je wyślesz.

{
  "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
  }
}

Wszystkie pola

Te pola trafiają do message_container. Karta potrzebuje opisu albo loadera. Pola oznaczone jako „Odpowiedzi na komendy” są pomijane, gdy publikujesz przez webhook.

Status i statystyki diffu

Pigułka statusu opowiada historię, zanim ktokolwiek przeczyta tekst. Stoi obok tytułu albo, gdy tytułu nie ma, w stopce; statystyki diffu pojawiają się obok godziny. Jedno i drugie działa w odpowiedziach na komendy i korzysta z nich wbudowana integracja z GitHubem. Webhook je pomija.

#github

Message from GitHub• acme/web

Scalono pull request #212

Merged

11:20

Message from CI• acme/web

Build na main nie powiódł się

Failing

search.test.js: nie przeszły 2 z 212 testów.

11:24

Message from GitHub• acme/web

maya: push do main

Commit

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."
  }
}

Ikony

Mapowanie, które sprawdza się dla GitHuba

Wbudowana integracja z GitHubem używa tych wartości; skopiuj je do własnych narzędzi.

Loader i rozumowanie

Przy wszystkim, co chwilę trwa, jak odpowiedź AI czy długie zadanie, najpierw opublikuj kartę ze spinnerem, a potem zastąp ją wynikiem. Loader działa w webhookach i odpowiedziach na komendy. W odpowiedzi na komendę możesz też umieścić rozumowanie modelu w thinking: członkowie zobaczą przełącznik Show thinking zamiast ściany tekstu.

#assistant

Message from Assistant

Myślę…Czytam ostatnie 50 wiadomości

09:02

Najpierw: loader

#assistant

Message from Assistant

maya: kiedy jest standup?

Standup jest o 09:30, w #daily.

Show thinking

Sprawdzono przypięte wiadomości i cykliczne wydarzenie w #daily.

09:02

Potem: odpowiedź, rozumowanie zwinięte

{
  "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…"
  }
}

Aby zamienić loader na odpowiedź, zaktualizuj wiadomość nową kartą bez loader. Jak to zrobić, opisujemy w aktualizacjach na żywo.

Długie opisy

Opis może mieć do 50 000 bajtów. Po pierwszych 1000 członkowie widzą początek i przycisk Show more, który wczytuje resztę, więc długi raport nie zalewa kanału.

Wiadomości systemowe

Ustaw "type": "system_message" dla komunikatu zamiast posta bota: przerw serwisowych, zmian zasad i wszystkiego, co mówi w imieniu samej społeczności. Przyjmuje te same pola i przyciski.

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

Kolory

Kolor krawędzi to najszybszy sygnał na karcie. Używaj zawsze tego samego koloru dla tego samego rodzaju wiadomości.