Обновляйте сообщения вживую

Быстрый старт

1. 1

   Сохраните callback URL

   Каждая публикация через вебхук и каждый запрос команды приходят с callback_url для этого сообщения.

   bashКопировать

   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, чтобы обновить

   Отправьте новое состояние. Карточка изменится на месте для всех.

   bashКопировать

   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, чтобы удалить

   Тело не нужно.

   bashКопировать

   curl -X DELETE "$CALLBACK_URL"

Обновление сообщения

Отправьте JSON методом PUT на callback_url. Передавайте только то, что хотите изменить.

Ответы

Сколько это работает

30 минут с момента публикации сообщения или использования команды. Обновление этот срок не продлевает. После удаления сообщения URL больше не действует. Через обновление нельзя добавить файлы.

Показ хода работы

Опубликуйте карточку с индикатором загрузки, обновляйте её дополнительную строку по мере продвижения задачи и закончите результатом. Индикатор загрузки представляет собой спиннер со строкой и строкой поменьше под ней (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' }]
});

Удаление сообщения

Отправьте DELETE на callback_url, и сообщение исчезнет у всех. После этого URL использовать нельзя.

Прослушивание сообщения

stream_url представляет собой живой поток (Server-Sent Events) того, что происходит с вашим сообщением. Откройте его, и события будут приходить по мере того, как они происходят, каждое в виде JSON-строки data:, в которой type говорит, что это за событие:

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

Прослушивание на 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();
});

Где его взять

Ошибки