Aktualizuj zprávy živě

Rychlý start

1. 1

   Uschovej si callback URL

   Každý příspěvek z webhooku a každý požadavek příkazu přichází s callback_url pro danou zprávu.

   bashKopírovat

   BODY='{"message_container": {"color": "blue", "loader": true, "loader_text": "Deploying…"}}'
   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"
   
   # {"success": true, "message_id": "...", "callback_url": "https://mss.gs/api/v1/trigger-callback/8f14e45f-..."}

2. 2

   PUT pro aktualizaci

   Pošli nový stav. Karta se všem změní přímo na místě.

   bashKopírovat

   curl -X PUT "$CALLBACK_URL" -H "Content-Type: application/json" \
     -d '{"message_container": {"color": "green", "title": "Deploy complete", "description": "v2.1 is live."}}'

3. 3

   DELETE pro smazání

   Tělo požadavku není potřeba.

   bashKopírovat

   curl -X DELETE "$CALLBACK_URL"

Aktualizace zprávy

Pošli JSON metodou PUT na callback_url. Posílej jen to, co chceš změnit.

Odpovědi

Jak dlouho funguje

30 minut od chvíle, kdy byla zpráva odeslána nebo příkaz použit. Aktualizace tuto dobu neprodlužuje. Smazáním zprávy se URL spotřebuje. Soubory přes aktualizaci přidat nelze.

Ukázání průběhu

Pošli kartu s loaderem, s postupem úlohy aktualizuj její podtext a skonči výsledkem. Loader je točící se kolečko s řádkem textu a menším řádkem pod ním (loader_text, loader_sub_text).

const { callback_url } = await post({
  message_container: { color: 'blue', loader: true, loader_text: 'Deploying…', loader_sub_text: 'Step 1 of 3: building' }
});

const update = (body) => {
  return fetch(callback_url, { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify(body) });
};

await build();
await update({ message_container: { color: 'blue', loader: true, loader_text: 'Deploying…', loader_sub_text: 'Step 2 of 3: running migrations' } });

await migrate();
await update({
  message_container: { color: 'green', title: 'Deploy complete', description: 'v2.1 is live on production.' },
  actions: [{ type: 'url:https://ci.example.com/deploys/218', text: 'View logs', color: 'green' }]
});

Smazání zprávy

Pošli DELETE na callback_url a zpráva všem zmizí. Tu URL pak už nelze znovu použít.

Poslech zprávy

stream_url je živý stream (Server-Sent Events) toho, co se děje s tvou zprávou. Otevři ho a události přicházejí, jak se dějí, každá jako řádek JSON data:, jehož type říká, o co jde:

curl -N "$STREAM_URL"

data: {"type": "reaction", "message_id": "...", "emoji": ":tada:", "action": "add", "member_guid": "...", "member": {...}, "ts": 1790000000000}

data: {"type": "action", "message_id": "...", "action_id": "approve", "action": {"id": "approve", "payload": {"deploy": 218}, ...}, "member_guid": "...", "member": {...}, "ts": 1790000004200}

data: {"type": "reply", "message_id": "...", "content": "Ship it!", "member_guid": "...", "member": {...}, "ts": 1790000009800}

event: expired
data: {}

Poslech v JavaScriptu

const events = new EventSource(streamUrl);

// Every event arrives as a plain message; its kind is in "type".
events.onmessage = (e) => {
  const ev = JSON.parse(e.data);
  if ((ev.type === 'action') && (ev.action_id === 'approve')) {
    startDeploy(ev.action.payload.deploy);
  }
};

// The one named event: the stream is closing.
events.addEventListener('expired', () => {
  events.close();
});

Kde ho získáš

Chyby