Opdatér beskeder live

Kom godt i gang

1. 1

   Gem callback-URL'en

   Alle opslag fra en webhook og alle requests fra en kommando kommer med en callback_url til den besked.

   bashKopiér

   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 for at opdatere

   Send den nye tilstand. Kortet ændrer sig på stedet for alle.

   bashKopiér

   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 for at fjerne

   Ingen body nødvendig.

   bashKopiér

   curl -X DELETE "$CALLBACK_URL"

Opdatér en besked

Send JSON med PUT til callback_url. Send kun det, du vil ændre.

Svar

Hvor længe den virker

30 minutter fra det øjeblik, beskeden blev postet, eller kommandoen blev brugt. En opdatering forlænger ikke tiden. Sletter du beskeden, er URL'en brugt op. Filer kan ikke tilføjes gennem en opdatering.

Vis fremskridt

Post et kort med en loader, opdatér dens undertekst, efterhånden som jobbet skrider frem, og slut af med resultatet. Loaderen er en spinner med en linje og en mindre linje 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' }]
});

Slet en besked

Send DELETE til callback_url, så er beskeden væk for alle. URL'en kan ikke bruges igen bagefter.

Lyt til en besked

En stream_url er en live stream (Server-Sent Events) af det, der sker på din besked. Åbn den, så ankommer hændelserne, efterhånden som de sker, hver som en JSON-linje med data:, hvis type siger, hvad det er:

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

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

Hvor du får en

Fejl