Designa meddelandekort

Ett korts anatomi

Kortets delar, uppifrån och ned. Utelämna det du inte behöver: ett kort med bara en rubrik går bra.

#github

Meddelande från GitHub• acme/web

Pull request #212 öppnad

Öppen

Snabbare sökning i kanallistan

Sökningen körs nu vid varje tangenttryckning med 120 ms debounce.

Författare

maya

Granskare

dani, sam

10:03

+86-12

1. Sidhuvud"Meddelande från" och ett namn: webhookens namn, eller din communitys namn för ett kommandosvar. Ett svar kan lägga till ett badge, som repot.
2. Rubrik och statustitle, en länk när du anger title_url, med status-pillen bredvid.
3. UnderrubrikEn andra rad i fetstil, sub_title.
4. BeskrivningBrödtexten, i markdown.
5. FältRader med etikett och värde, med en kopieringsknapp.
6. SidfotTiden, och tillagda och borttagna rader om du skickar dem.

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

Alla fält

De här ligger i message_container. Ett kort behöver en beskrivning, eller ett laddningsläge. Fält som är märkta "Kommandosvar" tas bort när du postar via en webhook.

Status och diff-statistik

En statuspill berättar historien innan någon har läst texten. Den sitter bredvid rubriken, eller i sidfoten när det inte finns någon rubrik; diff-statistiken visas bredvid tiden. Båda fungerar i kommandosvar, och den inbyggda GitHub-integrationen använder dem. En webhook tar bort dem.

#github

Meddelande från GitHub• acme/web

Pull request #212 mergad

Mergad

11:20

Meddelande från CI• acme/web

Bygget misslyckades på main

Underkänd

search.test.js: 2 av 212 tester misslyckades.

11:24

Meddelande från GitHub• acme/web

maya pushade till 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."
  }
}

Ikoner

En mappning som fungerar för GitHub

Den inbyggda GitHub-integrationen använder de här etiketterna; kopiera dem till dina egna verktyg.

Laddning och tänkande

För allt som tar en stund, som ett AI-svar eller ett långt jobb, postar du först ett kort med en spinner och ersätter det sedan med resultatet. Laddningsläget fungerar från webhooks och kommandosvar. I ett kommandosvar kan du också lägga modellens resonemang i thinking: medlemmarna ser en Visa tänkande-växlare i stället för en vägg av text.

#assistant

Meddelande från Assistant

Tänker…Läser de senaste 50 meddelandena

09:02

Först: laddningskortet

#assistant

Meddelande från Assistant

maya: när är standupen?

Standupen är 09:30, i #daily.

Visa tänkande

Kollade de fästa meddelandena och den återkommande händelsen i #daily.

09:02

Sedan: svaret, med resonemanget hopfällt

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

För att byta laddningskortet mot svaret uppdaterar du meddelandet med ett nytt kort utan loader. Hur det går till står under liveuppdateringar.

Långa beskrivningar

En beskrivning kan vara upp till 50 000 byte. Efter de första 1 000 ser medlemmarna början och en Visa mer-knapp som laddar resten, så att en lång rapport inte översvämmar kanalen.

Systemmeddelanden

Ange "type": "system_message" för ett meddelande som talar för communityn snarare än ett botinlägg: underhållsfönster, ändrade regler, allt där communityn själv har ordet. Det tar samma fält och knappar.

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

Färger

Kantens färg är den snabbaste signalen på ett kort. Använd samma färg för samma sorts nyhet, varje gång.