Aggiorna i messaggi in tempo reale

Per iniziare

1. 1

   Conserva la callback URL

   Ogni post da webhook e ogni richiesta di un comando arriva con una callback_url per quel messaggio.

   bashCopia

   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 per aggiornare

   Invia il nuovo stato. La card cambia sul posto per tutti.

   bashCopia

   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 per rimuovere

   Non serve nessun body.

   bashCopia

   curl -X DELETE "$CALLBACK_URL"

Aggiornare un messaggio

Invia JSON in PUT alla callback_url. Invia solo ciò che vuoi cambiare.

Risposte

Per quanto tempo funziona

30 minuti dal momento in cui il messaggio è stato pubblicato, o in cui è stato usato il comando. Aggiornare non allunga questo tempo. Eliminare il messaggio consuma l’URL. Con un aggiornamento non si possono aggiungere file.

Mostrare l’avanzamento

Pubblica una card con un loader, aggiorna il suo testo secondario man mano che il lavoro avanza e chiudi con il risultato. Il loader è uno spinner con una riga e una riga più piccola sotto (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' }]
});

Eliminare un messaggio

Invia DELETE alla callback_url e il messaggio sparisce per tutti. Dopo, l’URL non si può più usare.

Ascoltare un messaggio

Uno stream_url è uno stream live (Server-Sent Events) di ciò che succede sul tuo messaggio. Aprilo e gli eventi arrivano man mano che accadono, ognuno come riga JSON data: il cui type dice di cosa si tratta:

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

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

Dove ne ricevi uno

Errori