Mettre à jour des messages en direct

Démarrage rapide

1. 1

   Garde l’URL de callback

   Chaque publication par webhook et chaque requête de commande arrive avec une callback_url pour ce message.

   bashCopier

   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 pour mettre à jour

   Envoie le nouvel état. La carte change sur place pour tout le monde.

   bashCopier

   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 pour supprimer

   Aucun corps nécessaire.

   bashCopier

   curl -X DELETE "$CALLBACK_URL"

Mettre à jour un message

Envoie du JSON en PUT à la callback_url. N’envoie que ce que tu veux changer.

Réponses

Combien de temps elle fonctionne

30 minutes à partir du moment où le message a été publié, ou où la commande a été utilisée. Une mise à jour ne prolonge pas ce délai. Supprimer le message rend l’URL inutilisable. Une mise à jour ne permet pas d’ajouter des fichiers.

Afficher la progression

Publie une carte avec un chargement, mets à jour sa ligne secondaire à mesure que la tâche avance, et termine sur le résultat. Le chargement est un indicateur qui tourne, avec une ligne et une ligne plus petite en dessous (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' }]
});

Supprimer un message

Envoie DELETE à la callback_url et le message disparaît pour tout le monde. L’URL ne peut plus servir ensuite.

Écouter un message

Une stream_url est un flux en direct (Server-Sent Events) de ce qui se passe sur ton message. Ouvre-la et les événements arrivent au fur et à mesure, chacun sous forme de ligne JSON data: dont le type indique de quoi il s’agit :

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

Écouter en 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();
});

Où en obtenir une

Erreurs