Posílej zprávy webhookem

Rychlý start

1. 1

   Vytvoř webhook

   V desktopové aplikaci otevři ve své komunitě Manage Server → Webhooks, vytvoř webhook, vyber kanály, do kterých smí posílat, a zkopíruj URL pro daný kanál. Vypadá takto:

   urlKopírovat

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

2. 2

   Pošli zprávu

   Podepiš JSON tajným klíčem webhooku a pošli ho metodou POST. Webhook vytvořený v desktopové aplikaci ho má vždy: zkopíruj ho z pole Webhook Secret v nastavení webhooku.

   bashKopírovat

   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

   Přečti odpověď

   Odpověď ti vrátí id zprávy a callback_url pro pozdější úpravu zprávy.

   jsonKopírovat

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

Co můžeš poslat

Zpráva je buď krátká forma (text s nadpisem a barvou), nebo plná karta, a obě můžou nést tlačítka a soubory. Jméno nahoře na kartě je vždy jméno samotného webhooku. V nastavení webhooku také určíš, jestli smí posílat obrázky a zmiňovat lidi.

Krátká forma

Na většinu upozornění stačí.

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

Plná karta

Pošli message_container a dostaneš kartu s nadpisem jako odkazem, podnadpisem, markdownem, poli a obrázky. Přes webhook karta přijímá type, color, title, title_url, sub_title, description, fields, avatar_url, image_url, image_base64, images a pole loaderu. Štítek stavu, odznak, statistiky diffu a sbalené uvažování patří odpovědím na příkazy. Všechna pole najdeš na stránce karty zpráv.

jsonKopírovat

{
  "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 prošel

Všech 212 testů na main je zelených.

Duration

2m 34s

Commit

1a2b3c4

09:12

Tlačítka

Přidej pole actions a pod zprávou se objeví tlačítka. Jak fungují, popisuje stránka tlačítka.

Soubory

Posílej se zprávou skutečné soubory: log, report, snímek obrazovky. Zobrazí se jako každá jiná příloha, jako řádek ke stažení, a obrázky, video a zvuk přímo ve zprávě. Zpráva jen se soubory je v pořádku: vynech content i kartu.

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

Proč url bere jen adresy mssgs

URL webhooku často skončí vložená v dalších dashboardech. Když unikne, nesmí nikomu umožnit, aby aplikace každého člena stahovala soubor ze serveru, který si sám vybral. Pokud je tvůj soubor jinde, pošli ho jako content_base64 a mssgs ho bude hostovat.

Nepovedené nahrání souboru zprávu nezastaví

Soubory se kontrolují předem, ale nahrávají se až potom. Když nahrání selže, ten soubor vypadne a zbytek zprávy se přesto zveřejní, bez chyby: přijít o soubor je lepší než přijít o report. Pokud na souboru záleží, ověř si, že dorazil.

Soubor z příkazové řádky

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 @-

Podepisování požadavků

Webhook s tajným klíčem přijímá jen požadavky, které dokážou, že ho znají, a webhook vytvořený v desktopové aplikaci ho má vždy (Webhook Secret v jeho nastavení). Podepiš surové tělo požadavku pomocí HMAC-SHA256 s tajným klíčem a pošli hex digest malými písmeny v hlavičce X-Mssgs-Signature jako 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
});

Přijímá se i vlastní hlavička GitHubu X-Hub-Signature-256, takže webhook z GitHubu se stejným tajným klíčem funguje beze změn. Podpis nemá časové razítko, takže nezabrání opakovanému odeslání zachyceného požadavku: tajemstvím, na kterém opravdu záleží, zůstává URL.

Odpovědi a chyby

Zveřejněná zpráva se vrátí se svým id a odkazem callback_url, přes který ji můžeš 30 minut aktualizovat nebo smazat.

{
  "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}`);
}

Když má zpráva tlačítka, odpověď obsahuje i stream_url: živý stream odpovědí, reakcí a stisknutí tlačítek u té zprávy, otevřený 10 minut, nebo hodinu, když pošleš "sse_event_extended_timeout": true. Viz živé aktualizace.

Stavové kódy

Chybové kódy

Chyby souborů

Limity

Počet požadavků je omezený. Když dostaneš 429, chvíli počkej, než pošleš další, a upozornění, která chodí v dávkách, spoj do jedné zprávy.

GitHub, UniFi a App Store Connect

Nasměruj některou z těchto služeb na URL webhooku a mssgs ji pozná a zveřejní pořádnou kartu, bez psaní payloadu. Viz integrace. Tyto služby dostanou odpověď {"success": true} a žádnou callback URL.