Päivitä viestejä livenä

Pika-aloitus

1. 1

   Säilytä callback-URL

   Jokaisen webhook-julkaisun ja jokaisen komennon pyynnön mukana tulee kyseisen viestin callback_url.

   bashKopioi

   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 päivittää

   Lähetä uusi tila. Kortti muuttuu paikallaan kaikille.

   bashKopioi

   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 poistaa

   Bodya ei tarvita.

   bashKopioi

   curl -X DELETE "$CALLBACK_URL"

Päivitä viesti

Lähetä JSON PUT-pyynnöllä callback_url-osoitteeseen. Lähetä vain se, mitä haluat muuttaa.

Vastaukset

Kuinka kauan se toimii

30 minuuttia siitä hetkestä, kun viesti julkaistiin tai komentoa käytettiin. Päivittäminen ei pidennä aikaa. Viestin poistaminen käyttää URL:n loppuun. Tiedostoja ei voi lisätä päivityksellä.

Näytä edistyminen

Julkaise kortti latausilmaisimella, päivitä sen alariviä työn edetessä ja päätä tulokseen. Latausilmaisin on pyörivä kuvake, jonka vieressä on rivi ja sen alla pienempi rivi (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' }]
});

Poista viesti

Lähetä DELETE callback_url-osoitteeseen, niin viesti katoaa kaikilta. URL:ää ei voi käyttää sen jälkeen uudelleen.

Kuuntele viestiä

stream_url on reaaliaikainen virta (Server-Sent Events) siitä, mitä viestissäsi tapahtuu. Avaa se, niin tapahtumat saapuvat sitä mukaa kuin niitä tapahtuu, kukin JSON-muotoisena data:-rivinä, jonka type kertoo, mistä on kyse:

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

Kuuntelu JavaScriptillä

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

Mistä saat virran

Virheet