Ažuriraj poruke uživo

Brzi početak

1. 1

   Sačuvaj callback URL

   Svaka objava putem webhooka i svaki zahtjev naredbe dolazi s callback_url za tu poruku.

   bashKopiraj

   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 za ažuriranje

   Pošalji novo stanje. Kartica se mijenja na istom mjestu za sve.

   bashKopiraj

   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 za uklanjanje

   Tijelo zahtjeva nije potrebno.

   bashKopiraj

   curl -X DELETE "$CALLBACK_URL"

Ažuriranje poruke

Pošalji JSON metodom PUT na callback_url. Šalji samo ono što želiš promijeniti.

Odgovori

Koliko dugo radi

30 minuta od trenutka kad je poruka objavljena ili kad je naredba upotrijebljena. Ažuriranje ne produljuje taj rok. Brisanjem poruke URL se troši. Kroz ažuriranje ne možeš dodavati datoteke.

Prikaz napretka

Objavi karticu s loaderom, ažuriraj njezin podtekst kako posao napreduje i završi rezultatom. Loader je spinner s jednim retkom teksta i manjim retkom ispod njega (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' }]
});

Brisanje poruke

Pošalji DELETE na callback_url i poruka nestaje za sve. Nakon toga URL se više ne može koristiti.

Slušanje poruke

stream_url je stream uživo (Server-Sent Events) onoga što se događa s tvojom porukom. Otvori ga i događaji stižu čim se dogode, svaki kao JSON redak data: čiji type govori o čemu je riječ:

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

Slušanje u 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();
});

Gdje ga dobivaš

Pogreške