Publique mensagens com um webhook

Início rápido

1. 1

   Crie o webhook

   No app para computador, abra Manage Server → Webhooks da sua comunidade, crie um webhook, escolha os canais em que ele pode publicar e copie a URL de um canal. Ela tem este formato:

   urlCopiar

   https://mss.gs/api/v1/webhook/{webhook_guid}/{token}/{channel_guid}

2. 2

   Envie uma mensagem

   Assine o JSON com o secret do webhook e faça um POST. Um webhook criado no app para computador sempre tem um: copie-o de Webhook Secret nas configurações do webhook.

   bashCopiar

   BODY='{"content": "Build #1847 passed on main"}'
   SIG=$(printf '%s' "$BODY" | openssl dgst -sha256 -hmac "$MSSGS_WEBHOOK_SECRET" | sed 's/^.* //')
   
   curl -X POST "$MSSGS_WEBHOOK_URL" \
     -H "Content-Type: application/json" \
     -H "X-Mssgs-Signature: sha256=$SIG" \
     -d "$BODY"

3. 3

   Leia a resposta

   A resposta traz o id da mensagem e uma callback_url para mudar a mensagem depois.

   jsonCopiar

   {
     "success": true,
     "message_id": "aZZ1a2b-...",
     "callback_url": "https://mss.gs/api/v1/trigger-callback/8f14e45f-...",
     "stream_url": "https://mss.gs/api/v1/instant/6b1e...c0?token=a1b2c3d4-..."
   }

O que você pode enviar

Uma mensagem é a forma curta (texto com título e cor) ou um cartão completo, e as duas podem levar botões e arquivos. O nome no topo do cartão é sempre o nome do próprio webhook. Nas configurações do webhook você também decide se ele pode publicar imagens e mencionar pessoas.

Forma curta

Suficiente para a maioria dos alertas.

{
  "content": "Server backup completed at 03:00 UTC",
  "color": "green",
  "title": "Backup Bot"
}

Um cartão completo

Envie um message_container para ter um cartão com título em link, subtítulo, markdown, campos e imagens. Por um webhook, um cartão aceita type, color, title, title_url, sub_title, description, fields, avatar_url, image_url, image_base64, images e os campos do loader. A pílula de status, o selo, as estatísticas de diff e o raciocínio recolhido são para respostas a comandos. Todos os campos estão em cartões de mensagem.

jsonCopiar

{
  "message_container": {
    "type": "embed_message",
    "color": "green",
    "title": "Build #1847 passed",
    "title_url": "https://ci.example.com/builds/1847",
    "description": "All 212 tests green on **main**.",
    "fields": [
      { "field": "Duration", "value": "2m 34s" },
      { "field": "Commit", "value": "1a2b3c4" }
    ]
  }
}

#deploys

Message from CI

Build #1847 passou

Todos os 212 testes verdes em main.

Duration

2m 34s

Commit

1a2b3c4

09:12

Botões

Adicione um array actions para colocar botões embaixo da mensagem. Como eles funcionam está em botões.

Arquivos

Publique arquivos de verdade com uma mensagem: um log, um relatório, uma captura de tela. Eles aparecem como qualquer outro anexo, numa linha de download ou, no caso de imagens, vídeo e áudio, direto na mensagem. Uma mensagem só com arquivos também vale: deixe de fora content e o cartão.

{
  "message_container": {
    "color": "orange",
    "title": "Log dump: ios",
    "description": "DMs stopped arriving after switching networks"
  },
  "attachments": [
    {
      "name": "mssgs-logs-20260803-141205.log",
      "content_base64": "MjAyNi0wOC0wMyAxNDoxMjowNSBbV1NdIGNvbm5lY3RlZAo=",
      "mime_type": "text/plain"
    }
  ]
}

Por que url só aceita endereços do mssgs

A URL de um webhook costuma acabar colada em outros painéis. Se ela vazar, não pode permitir que alguém faça o app de cada membro baixar um arquivo de um servidor escolhido por essa pessoa. Se o seu arquivo está em outro lugar, envie como content_base64 e o mssgs hospeda.

Um upload que falha não derruba a mensagem

Os arquivos são verificados antes, mas enviados depois. Se um upload falhar, esse arquivo fica de fora e o resto da mensagem é publicado mesmo assim, sem erro: perder o arquivo é melhor do que perder o relatório. Se um arquivo for importante, confira se ele chegou.

Um arquivo pela linha de comando

BODY='{"attachments":[{"name":"report.csv","content_base64":"'"$(base64 < report.csv | tr -d '\n')"'","mime_type":"text/csv"}]}'
SIG=$(printf '%s' "$BODY" | openssl dgst -sha256 -hmac "$MSSGS_WEBHOOK_SECRET" | sed 's/^.* //')

printf '%s' "$BODY" | curl -sS -X POST "$MSSGS_WEBHOOK_URL" \
  -H 'Content-Type: application/json' \
  -H "X-Mssgs-Signature: sha256=$SIG" \
  --data-binary @-

Assinatura das requisições

Um webhook com secret só aceita requisições que provem que o conhecem, e um webhook criado no app para computador sempre tem um (Webhook Secret nas configurações dele). Assine o corpo bruto da requisição com HMAC-SHA256 usando o secret e envie o digest em hexadecimal minúsculo no header X-Mssgs-Signature como sha256=<hex>.

import crypto from 'node:crypto';

const body = JSON.stringify({ content: 'Deploy finished' });
const signature = crypto.createHmac('sha256', process.env.MSSGS_WEBHOOK_SECRET)
  .update(body)
  .digest('hex');

await fetch(process.env.MSSGS_WEBHOOK_URL, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Mssgs-Signature': `sha256=${signature}`
  },
  body
});

O header próprio do GitHub, X-Hub-Signature-256, também é aceito, então um webhook do GitHub com o mesmo secret funciona como está. A assinatura não tem timestamp, então não impede que uma requisição capturada seja reenviada: a URL continua sendo o segredo que importa.

Respostas e erros

Uma mensagem publicada volta com o id dela e uma callback_url para atualizá-la ou apagá-la durante 30 minutos.

{
  "success": true,
  "message_id": "aZZ1a2b-...",
  "callback_url": "https://mss.gs/api/v1/trigger-callback/8f14e45f-...",
  "stream_url": "https://mss.gs/api/v1/instant/6b1e...c0?token=a1b2c3d4-..."
}

HTTP/1.1 200 OK
Content-Type: application/json

{ "error": "ATTACHMENT_TOO_LARGE" }

const res = await fetch(webhookUrl, { method: 'POST', headers, body });
const reply = await res.json().catch(() => null);

// A rejected payload still comes back as 200: read the body.
if (!res.ok || (reply && reply.error)) {
  throw new Error(`webhook rejected: ${reply?.error ?? res.status}`);
}

Quando a mensagem tem botões, a resposta também traz uma stream_url: um stream ao vivo das respostas, reações e toques em botões nessa mensagem, aberto por 10 minutos, ou por uma hora se você enviar "sse_event_extended_timeout": true. Veja atualizações ao vivo.

Códigos de status

Códigos de erro

Erros de arquivo

Limites

As requisições têm limite de taxa. Quando receber um 429, espere antes de enviar de novo, e junte numa só mensagem os alertas que chegam em rajadas.

GitHub, UniFi e App Store Connect

Aponte um desses serviços para a URL de um webhook e o mssgs o reconhece e publica um cartão caprichado, sem payload para escrever. Veja integrações. Eles recebem {"success": true} como resposta, sem callback URL.