Glitch
Документация API · Карточки

Вебхуки

Карточки

Карточка — это блок под текстом сообщения. У неё цветная полоса слева, а внутри могут быть автор, заголовок со ссылкой, описание, поля, большая и маленькая картинки и подпись с временем. Карточки удобны для отчётов, уведомлений о событиях и всего, где у сообщения есть структура.

В одном сообщении может быть до 10 карточек. Сообщение может состоять только из карточек, без текста. Карточки отправляют программы. Люди в приложении карточки не создают.

Пример

JSON
{
  "username": "CI",
  "embeds": [{
    "author": {
      "name": "octocat",
      "url": "https://github.com/octocat",
      "icon_url": "https://avatars.githubusercontent.com/u/583231"
    },
    "title": "Сборка 1.4.2 прошла",
    "url": "https://example.com/builds/142",
    "description": "Все проверки зелёные, версия выложена на сервер.",
    "color": 3124890,
    "fields": [
      {"name": "Ветка", "value": "master", "inline": true},
      {"name": "Длительность", "value": "2 мин 14 с", "inline": true},
      {"name": "Изменения", "value": "Исправлен вход через QR-код"}
    ],
    "thumbnail": {"url": "https://example.com/logo.png"},
    "image": {"url": "https://example.com/coverage.png"},
    "footer": {"text": "Сборка №142", "icon_url": "https://example.com/ci.png"},
    "timestamp": "2026-10-28T08:30:00+00:00"
  }]
}

Части карточки

Все части необязательны, но в карточке должно быть хоть что-то видимое, иначе запрос получит отказ.

ПолеТипЧто это
titleстрокаЗаголовок, до 256 знаков
urlстрокаСсылка, на которую ведёт заголовок. Только https:// или http://
descriptionстрокаОсновной текст, до 4096 знаков. Переносы строк сохраняются
colorчислоЦвет полосы слева, число от 0 до 16777215 (0xFFFFFF). Без него полоса обычного цвета
timestampстрокаВремя в подписи, ISO 8601. Приложение покажет его в часовом поясе читателя
authorобъектАвтор над заголовком, см. ниже
fieldsмассивПоля, до 25 штук, см. ниже
imageобъектБольшая картинка под текстом, {"url": "…"}
thumbnailобъектМаленькая картинка справа, {"url": "…"}
footerобъектПодпись внизу, см. ниже

Автор

ПолеЧто это
nameИмя, обязательно, до 256 знаков
urlСсылка, на которую ведёт имя
icon_urlМаленькая картинка рядом с именем

Поля

ПолеЧто это
nameНазвание поля, обязательно, до 256 знаков
valueЗначение, обязательно, до 1024 знаков
inlinetrue, чтобы поле встало в ряд с соседними. По умолчанию false, поле занимает всю ширину

Подпись

ПолеЧто это
textТекст подписи, обязательно, до 2048 знаков
icon_urlМаленькая картинка рядом с подписью

Пределы

ЧтоПредел
Карточек в одном сообщении10
Заголовок256 знаков
Описание4096 знаков
Полей в карточке25
Название поля256 знаков
Значение поля1024 знаков
Имя автора256 знаков
Текст подписи2048 знаков
Любая ссылка2048 знаков
Весь текст всех карточек сообщения вместе6000 знаков

В общий предел текста входят заголовки, описания, названия и значения полей, тексты подписей и имена авторов всех карточек сообщения. Пределы те же, что в Discord.

Цвет

Цвет полосы задаётся одним числом, в котором записан цвет в виде 0xRRGGBB. В большинстве языков его можно написать прямо в шестнадцатеричном виде.

ЦветШестнадцатеричныйЧисло для JSON
Изумрудный Glitch0x2FAE9A3124890
Красный0xE74C3C15158332
Жёлтый0xF1C40F15844367
Синий0x3498DB3447003

В JSON шестнадцатеричная запись не поддерживается, поэтому там нужно десятичное число.

Картинки

Картинки карточки задаются в image, thumbnail, author.icon_url и footer.icon_url. Есть два способа.

Ссылкой. Укажите ссылку https:// на картинку PNG, JPEG, WebP или GIF. Сервер сам скачает её и сохранит у себя, поэтому в ответе ссылка будет вести уже на хранилище Glitch. Размеры картинки (width, height) сервер тоже измеряет сам. Если картинку скачать не удалось, она просто не покажется, а сообщение всё равно отправится.

Файлом из того же запроса. Приложите картинку к сообщению и укажите в карточке attachment://имя_файла. Такая картинка показывается только в карточке, отдельным вложением она уже не идёт.

curl
curl -X POST "https://api.glitchapp.online/v10/webhooks/ID/KEY" \
  -F 'payload_json={"embeds": [{"title": "Покрытие тестами", "image": {"url": "attachment://coverage.png"}}]}' \
  -F "files[0]=@coverage.png"

Имя после attachment:// должно совпадать с именем приложенного файла.

Правка карточек

При правке сообщения поле embeds заменяет карточки целиком. Чтобы изменить одну карточку из нескольких, пришлите их все. "embeds": [] убирает все карточки. Если embeds в запросе нет, карточки остаются как были.

При правке новые файлы приложить нельзя, поэтому картинки в изменённых карточках задаются только ссылками.

Что не поддерживается

  • Поля Discord video, provider и type сервер пропускает, как это делает Discord. Карточки от программ всегда вида rich.
  • Разметки текста в карточках пока нет. Звёздочки, подчёркивания и прочие символы Markdown показываются как есть.
На этой странице
  1. Пример
  2. Части карточки
  3. Пределы
  4. Цвет
  5. Картинки
  6. Правка карточек
  7. Что не поддерживается