Aktualizuj wiadomości na żywo

Szybki start

1. 1

   Zachowaj callback URL

   Każdy post z webhooka i każde żądanie komendy ma callback_url tej wiadomości.

   bashKopiuj

   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, żeby zaktualizować

   Wyślij nowy stan. Karta zmienia się w miejscu u wszystkich.

   bashKopiuj

   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, żeby usunąć

   Body nie jest potrzebne.

   bashKopiuj

   curl -X DELETE "$CALLBACK_URL"

Aktualizacja wiadomości

Wyślij JSON metodą PUT na callback_url. Wysyłaj tylko to, co chcesz zmienić.

Odpowiedzi

Jak długo działa

30 minut od chwili wysłania wiadomości albo użycia komendy. Aktualizacja nie wydłuża tego czasu. Usunięcie wiadomości zużywa URL. Przez aktualizację nie można dodawać plików.

Pokazywanie postępu

Wyślij kartę z loaderem, aktualizuj jej podtekst w miarę postępu zadania i zakończ wynikiem. Loader to spinner z wierszem tekstu i mniejszym wierszem pod nim (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' }]
});

Usuwanie wiadomości

Wyślij DELETE na callback_url, a wiadomość zniknie u wszystkich. Potem tego URL-a nie można już użyć.

Nasłuchiwanie wiadomości

stream_url to strumień na żywo (Server-Sent Events) tego, co dzieje się z twoją wiadomością. Otwórz go, a zdarzenia przychodzą na bieżąco, każde jako wiersz JSON data:, którego type mówi, czym jest:

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

Nasłuchiwanie w JavaScripcie

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();
});

Skąd go wziąć

Błędy