Оновлюйте повідомлення наживо

Швидкий старт

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

Де його отримати

Помилки