Aktualizuj správy naživo

Rýchly štart

1. 1

   Uchovaj si callback URL

   Každý príspevok cez webhook a každá požiadavka príkazu prichádza s callback_url pre danú správu.

   bashKopírovať

   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 na aktualizáciu

   Pošli nový stav. Karta sa zmení na mieste u všetkých.

   bashKopírovať

   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 na vymazanie

   Telo požiadavky netreba.

   bashKopírovať

   curl -X DELETE "$CALLBACK_URL"

Aktualizácia správy

Pošli JSON metódou PUT na callback_url. Posielaj len to, čo chceš zmeniť.

Odpovede

Ako dlho funguje

30 minút od chvíle, keď bola správa odoslaná alebo keď bol príkaz použitý. Aktualizácia túto dobu nepredĺži. Vymazaním správy sa URL spotrebuje. Cez aktualizáciu sa nedajú pridať súbory.

Ukáž priebeh

Pošli kartu s loaderom, aktualizuj jej podtext, ako úloha napreduje, a skonči výsledkom. Loader je spinner s riadkom textu a menším riadkom 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' }]
});

Vymazanie správy

Pošli DELETE na callback_url a správa zmizne u všetkých. URL sa potom už nedá znova použiť.

Počúvanie správy

stream_url je živý stream (Server-Sent Events) toho, čo sa deje s tvojou správou. Otvor ho a udalosti prichádzajú hneď, ako nastanú, každá ako JSON riadok data:, ktorého type hovorí, o čo ide:

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

Počúvanie v JavaScripte

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ískaš

Chyby