Скопіюйте готовий стартовий приклад для cURL, PHP/Laravel, Node.js, Python або Go. Використовуйте API-ключі з панелі керування, UUID одержувачів з робочого простору та зберігайте секрети поза вихідним кодом.
Офіційні клієнти
Два офіційно підтримувані клієнти огортають той самий REST API: пакет SDK для Python у PyPI та CLI на Go у вигляді одного виконуваного файлу. Встановіть, додайте ключ API — і викликайте чергового двома рядками.
Надсилайте сповіщення, запускайте шаблони та викликайте чергового з будь-якого застосунку, завдання чи конвеєра на Python. Має менеджер контексту guard(), який сповіщає, коли код викидає виняток.
Один статичний виконуваний файл для скриптів оболонки, завдань cron і раннерів CI. Спрямуйте невдалу команду одразу в сповіщення — без залежностей і середовища виконання.
Оберіть свій стек
Той самий JSON-контракт усюди. Вставте сніпет у проєкт, підставте API-ключ із панелі — і ви онлайн.
Живий запит
Ідемпотентні ендпоінти, помилки за RFC і конверт відповіді, який ви запишете прямо до таймлайну інциденту.
Найкращі практики
Створюйте API-ключі в панелі керування, зберігайте їх у змінних середовища або менеджерах секретів і ротируйте, коли змінюється доступ у команді.
Публічні приклади використовують recipient_uuid, щоб інтеграції не залежали від внутрішніх ID бази даних.
Передавайте сервіс, критичність, середовище та посилання на вихідну систему замість зайвих чутливих даних.
Порядок інтеграції
Згенеруйте ключ у налаштуваннях панелі керування та збережіть його поза вихідним кодом перед перевіркою прикладів.
Спочатку використайте sandbox-одержувача, перевірте маршрутизацію каналів, а потім підключайте бойову групу реагування.
Обробляйте відповіді не 2xx, журналюйте помилки у вихідній системі та уникайте дублювання критичних сповіщень.
Поверхня API
Надсилайте алерти, керуйте одержувачами, перевіряйте доставку — з одного REST-API, захищеного вашим ключем.
| Метод | Шлях | Призначення |
|---|---|---|
| POST | /api/v1/notifications/send | Надіслати сповіщення одержувачу з пріоритетом і каналами. |
| GET | /api/v1/notifications/{id} | Перевірити статус, спроби доставки та підтвердження. |
| POST | /api/v1/notifications/{id}/підтвердження | Програмно підтвердити інцидент і зупинити ескалацію. |
| GET | /api/v1/recipients | Перелічити одержувачів робочого простору із можливостями каналів. |
| POST | /api/v1/recipients | Створити одержувача з telegram_id, телефоном, e-mail і правилами. |
| PATCH | /api/v1/recipients/{uuid} | Оновити таймаути ескалації, порядок каналів або тихі години. |
Створіть робочий простір, скопіюйте будь-який сніпет із цієї сторінки і підставте API-ключ. Ваш перший алерт — за один запит.