Atjaunini ziņas reāllaikā

Ātrais sākums

1. 1

   Saglabā callback URL

   Katrs webhook ieraksts un katrs komandas pieprasījums nāk ar šīs ziņas callback_url.

   bashKopēt

   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, lai atjauninātu

   Nosūti jauno stāvokli. Kartīte mainās uz vietas visiem.

   bashKopēt

   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, lai noņemtu

   Body nav vajadzīgs.

   bashKopēt

   curl -X DELETE "$CALLBACK_URL"

Ziņas atjaunināšana

Sūti JSON ar PUT uz callback_url. Sūti tikai to, ko gribi mainīt.

Atbildes

Cik ilgi tas darbojas

30 minūtes no brīža, kad ziņa tika publicēta vai komanda izmantota. Atjaunināšana šo laiku nepagarina. Pēc ziņas dzēšanas URL vairs nedarbojas. Caur atjauninājumu nevar pievienot failus.

Progresa rādīšana

Publicē kartīti ar ielādes indikatoru, atjaunini tās apakštekstu, kamēr darbs virzās uz priekšu, un beidz ar rezultātu. Ielādes indikators ir griezulis ar rindu un mazāku rindu zem tās (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' }]
});

Ziņas dzēšana

Nosūti DELETE uz callback_url, un ziņa pazūd visiem. Pēc tam URL vairs nevar izmantot.

Ziņas klausīšanās

stream_url ir reāllaika straume (Server-Sent Events) ar visu, kas notiek ar tavu ziņu. Atver to, un notikumi pienāk, tiklīdz tie notiek, katrs kā JSON data: rinda, kuras type pasaka, kas tas ir:

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

Klausīšanās JavaScript

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 to dabūt

Kļūdas