Atnaujink žinutes realiu laiku

Greita pradžia

1. 1

   Išsaugok callback URL

   Kiekvienas webhook įrašas ir kiekviena komandos užklausa ateina su tos žinutės callback_url.

   bashKopijuoti

   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 atnaujinti

   Siųsk naują būseną. Kortelė pasikeičia vietoje visiems.

   bashKopijuoti

   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 pašalinti

   Užklausos turinio nereikia.

   bashKopijuoti

   curl -X DELETE "$CALLBACK_URL"

Žinutės atnaujinimas

Siųsk JSON metodu PUT į callback_url. Siųsk tik tai, ką nori pakeisti.

Atsakymai

Kiek laiko veikia

30 minučių nuo žinutės paskelbimo arba komandos panaudojimo akimirkos. Atnaujinimas šio laiko nepratęsia. Ištrynus žinutę URL nebegalioja. Per atnaujinimą failų pridėti negalima.

Eigos rodymas

Paskelbk kortelę su įkėlimo indikatoriumi, atnaujink jos papildomą eilutę, kai užduotis juda į priekį, ir baik rezultatu. Įkėlimo indikatorius yra suktukas su eilute teksto ir mažesne eilute po ja (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' }]
});

Žinutės ištrynimas

Siųsk DELETE į callback_url, ir žinutė dingsta visiems. Po to URL nebegalima naudoti.

Žinutės klausymasis

stream_url yra tiesioginis srautas (Server-Sent Events) to, kas vyksta su tavo žinute. Atidaryk jį, ir įvykiai ateina, kai tik įvyksta, kiekvienas kaip JSON data: eilutė, kurios type nurodo, kas tai:

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

Klausymasis JavaScript kalba

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

Kur jį gauni

Klaidos