Actualiza mensajes en directo

Inicio rápido

1. 1

   Guarda la callback URL

   Cada publicación de webhook y cada petición de comando trae una callback_url para ese mensaje.

   bashCopiar

   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 para actualizar

   Envía el nuevo estado. La tarjeta cambia en el mismo sitio para todos.

   bashCopiar

   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 para borrar

   No hace falta cuerpo.

   bashCopiar

   curl -X DELETE "$CALLBACK_URL"

Actualizar un mensaje

Envía JSON con PUT a la callback_url. Envía solo lo que quieras cambiar.

Respuestas

Cuánto tiempo funciona

30 minutos desde el momento en que se publicó el mensaje o se usó el comando. Actualizar no lo alarga. Borrar el mensaje agota la URL. No se pueden añadir archivos con una actualización.

Mostrar el progreso

Publica una tarjeta con un loader, actualiza su texto secundario a medida que avanza el trabajo y termina con el resultado. El loader es un spinner con una línea y otra más pequeña debajo (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' }]
});

Borrar un mensaje

Envía DELETE a la callback_url y el mensaje desaparece para todos. Después, la URL ya no se puede volver a usar.

Escuchar un mensaje

Una stream_url es un stream en directo (Server-Sent Events) de lo que pasa en tu mensaje. Ábrelo y los eventos llegan en cuanto ocurren, cada uno como una línea JSON data: cuyo type dice qué es:

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

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

De dónde sacas una

Errores