Uppdatera meddelanden live

Snabbstart

1. 1

   Spara callback-URL:en

   Varje inlägg från en webhook och varje anrop från ett kommando kommer med en callback_url för just det meddelandet.

   bashKopiera

   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 för att uppdatera

   Skicka det nya läget. Kortet ändras på plats för alla.

   bashKopiera

   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 för att ta bort

   Ingen body behövs.

   bashKopiera

   curl -X DELETE "$CALLBACK_URL"

Uppdatera ett meddelande

Gör en PUT med JSON till callback_url. Skicka bara det du vill ändra.

Svar

Hur länge den fungerar

30 minuter från det att meddelandet postades eller kommandot användes. En uppdatering förlänger inte tiden. När meddelandet raderas är URL:en förbrukad. Filer kan inte läggas till via en uppdatering.

Visa förloppet

Posta ett kort med en laddningsindikator, uppdatera undertexten allteftersom jobbet går framåt och avsluta med resultatet. Laddningsindikatorn är en spinner med en rad och en mindre rad under den (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' }]
});

Radera ett meddelande

Skicka DELETE till callback_url så försvinner meddelandet för alla. URL:en kan inte användas igen efteråt.

Lyssna på ett meddelande

En stream_url är en liveström (Server-Sent Events) av det som händer på ditt meddelande. Öppna den så kommer händelserna när de sker, var och en som en JSON-rad data: vars type säger vad det är:

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

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

Var du får en

Fel