Crie cartões de mensagem

Anatomia de um cartão

As partes de um cartão, de cima para baixo. Deixe de fora o que você não precisa: um cartão só com título também vale.

#github

Message from GitHub• acme/web

Pull request #212 aberto

Open

Busca mais rápida na lista de canais

A busca agora roda a cada tecla, com debounce de 120 ms.

Autor

maya

Revisores

dani, sam

10:03

+86-12

1. Cabeçalho“Message from” e um nome: o nome do webhook ou, numa resposta a comando, o nome da sua comunidade. Uma resposta pode acrescentar um badge, como o repositório.
2. Título e statusO title, que vira link quando você define title_url, com a pílula de status ao lado.
3. SubtítuloUma segunda linha em negrito, sub_title.
4. DescriçãoO corpo, em markdown.
5. CamposLinhas de rótulo e valor, com um botão de copiar.
6. RodapéO horário e as linhas adicionadas e removidas, se você as enviar.

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

Todos os campos

Estes campos vão em message_container. Um cartão precisa de uma descrição ou de um loader. Os campos marcados como “Respostas a comandos” são descartados quando você publica por um webhook.

Status e estatísticas de diff

Uma pílula de status conta a história antes que alguém leia o texto. Ela fica ao lado do título, ou no rodapé quando não há título; as estatísticas de diff aparecem ao lado do horário. As duas funcionam em respostas a comandos, e a integração nativa com o GitHub usa ambas. Um webhook as descarta.

#github

Message from GitHub• acme/web

Pull request #212 mesclado

Merged

11:20

Message from CI• acme/web

Build falhou na main

Failing

search.test.js: 2 de 212 testes falharam.

11:24

Message from GitHub• acme/web

maya fez push na 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."
  }
}

Ícones

Um mapeamento que funciona para o GitHub

A integração nativa com o GitHub usa estes valores; copie-os para as suas próprias ferramentas.

Loader e raciocínio

Para qualquer coisa que leve um momento, como uma resposta de IA ou um job longo, publique primeiro um cartão com um spinner e depois troque pelo resultado. O loader funciona em webhooks e em respostas a comandos. Numa resposta a comando, você também pode colocar o raciocínio do modelo em thinking: os membros veem um botão Show thinking em vez de um paredão de texto.

#assistant

Message from Assistant

Pensando…Lendo as últimas 50 mensagens

09:02

Primeiro: o loader

#assistant

Message from Assistant

maya: que horas é o standup?

O standup é às 09:30, em #daily.

Show thinking

Conferi as mensagens fixadas e o evento recorrente em #daily.

09:02

Depois: a resposta, com o raciocínio recolhido

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

Para trocar o loader pela resposta, atualize a mensagem com um cartão novo sem loader. Como fazer isso está em atualizações ao vivo.

Descrições longas

Uma descrição pode ter até 50.000 bytes. Passando dos primeiros 1.000, os membros veem o começo e um botão Show more que carrega o resto, para que um relatório longo não inunde o canal.

Mensagens de sistema

Defina "type": "system_message" para um aviso em vez de uma publicação de bot: janelas de manutenção, mudanças de regras, qualquer coisa que fale em nome da própria comunidade. Aceita os mesmos campos e botões.

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

Cores

A cor da borda é o sinal mais rápido de um cartão. Use sempre a mesma cor para o mesmo tipo de notícia.