Mesajları canlı güncelle

Hızlı başlangıç

1. 1

   Callback URL’sini sakla

   Her webhook gönderisi ve her komut isteği, o mesaj için bir callback_url ile gelir.

   bashKopyala

   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

   Güncellemek için PUT

   Yeni durumu gönder. Kart herkes için yerinde değişir.

   bashKopyala

   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

   Kaldırmak için DELETE

   Gövde gerekmez.

   bashKopyala

   curl -X DELETE "$CALLBACK_URL"

Bir mesajı güncelle

callback_url adresine PUT ile JSON gönder. Yalnızca değiştirmek istediğini gönder.

Yanıtlar

Ne kadar süre çalışır

Mesajın gönderildiği ya da komutun kullanıldığı andan itibaren 30 dakika. Güncellemek bu süreyi uzatmaz. Mesajı silmek URL’yi tüketir. Bir güncellemeyle dosya eklenemez.

İlerlemeyi göster

Yükleme göstergeli bir kart gönder, iş ilerledikçe alt metnini güncelle ve sonuçla bitir. Yükleme göstergesi, bir satır ve altında daha küçük bir satır bulunan dönen bir simgedir (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' }]
});

Bir mesajı sil

callback_url adresine DELETE gönder, mesaj herkes için kaybolur. URL bundan sonra tekrar kullanılamaz.

Bir mesajı dinle

stream_url, mesajında olup bitenlerin canlı bir akışıdır (Server-Sent Events). Aç, olaylar gerçekleştikçe gelsin; her biri, type alanı ne olduğunu söyleyen bir JSON data: satırıdır:

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

JavaScript’te dinlemek

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

Nereden alırsın

Hatalar