Nachrichten live aktualisieren

Schnellstart

1. 1

   Die Callback-URL aufbewahren

   Jeder Post per Webhook und jeder Request zu einem Befehl bringt eine callback_url für diese Nachricht mit.

   bashKopieren

   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 zum Aktualisieren

   Sende den neuen Zustand. Die Karte ändert sich für alle an Ort und Stelle.

   bashKopieren

   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 zum Entfernen

   Kein Body nötig.

   bashKopieren

   curl -X DELETE "$CALLBACK_URL"

Eine Nachricht aktualisieren

Sende JSON per PUT an die callback_url. Schick nur, was du ändern willst.

Antworten

Wie lange sie funktioniert

30 Minuten ab dem Moment, in dem die Nachricht gepostet oder der Befehl benutzt wurde. Ein Update verlängert das nicht. Das Löschen der Nachricht verbraucht die URL. Über ein Update lassen sich keine Dateien hinzufügen.

Fortschritt zeigen

Poste eine Karte mit Loader, aktualisiere ihren Untertext, während der Job vorankommt, und ende mit dem Ergebnis. Der Loader ist ein Spinner mit einer Zeile und einer kleineren Zeile darunter (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' }]
});

Eine Nachricht löschen

Sende DELETE an die callback_url, und die Nachricht ist für alle weg. Danach lässt sich die URL nicht mehr verwenden.

Eine Nachricht mithören

Eine stream_url ist ein Live-Stream (Server-Sent Events) dessen, was auf deiner Nachricht passiert. Öffne ihn, und Events kommen an, sobald sie passieren, jedes als JSON-Zeile data:, deren type sagt, was es ist:

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

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

Wo du einen bekommst

Fehler