Berichten live bijwerken

Snel aan de slag

1. 1

   Bewaar de callback-URL

   Elke post via een webhook en elk request voor een commando komt met een callback_url voor dat bericht.

   bashKopieer

   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 om bij te werken

   Stuur de nieuwe stand. De kaart verandert voor iedereen op dezelfde plek.

   bashKopieer

   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 om te verwijderen

   Geen body nodig.

   bashKopieer

   curl -X DELETE "$CALLBACK_URL"

Een bericht bijwerken

PUT JSON naar de callback_url. Stuur alleen wat je wilt veranderen.

Antwoorden

Hoe lang het werkt

30 minuten vanaf het moment dat het bericht is gepost, of dat het commando is gebruikt. Bijwerken verlengt dat niet. Het bericht verwijderen maakt de URL op. Via een update kun je geen bestanden toevoegen.

Voortgang tonen

Post een kaart met een loader, werk de subtekst bij terwijl de taak vordert, en eindig met het resultaat. De loader is een spinner met een regel en een kleinere regel eronder (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' }]
});

Een bericht verwijderen

Stuur DELETE naar de callback_url en het bericht is voor iedereen weg. Daarna kun je de URL niet meer gebruiken.

Naar een bericht luisteren

Een stream_url is een live stream (Server-Sent Events) van wat er op je bericht gebeurt. Open hem en events komen binnen zodra ze gebeuren, elk als een JSON-regel data: waarvan het type zegt wat het is:

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

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

Waar je er een krijgt

Fouten