Обробники сповіщень

Отримати всі

GET https://bitpeak.ru/api/notification-handlers/
curl --request GET \
--url 'https://bitpeak.ru/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Параметри Деталі Опис
page Необов’язково Ціле число Номер сторінки, з якої ви хочете отримати результати. За замовчуванням 1.
results_per_page Необов’язково Ціле число Скільки результатів ви хочете на сторінці. Дозволені значення: 10 , 25 , 50 , 100 , 250 , 500 , 1000. За замовчуванням 25. 
{
    "data": [
        {
            "id": 1,
            "type": "email",
            "name": "Work email",
            "settings": {
                "email": "hey@example.com"
            },
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2025-12-05 14:25:25",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://bitpeak.ru/api/notification-handlers?page=1",
        "last": "https://bitpeak.ru/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://bitpeak.ru/api/notification-handlers?page=1"
    }
}

Отримати один

GET https://bitpeak.ru/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://bitpeak.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "hey@example.com"
        },
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2025-12-05 14:25:25",
    }
}

Створити

POST https://bitpeak.ru/api/notification-handlers
Параметри Деталі Опис
name Обов'язково Рядок -
type Обов'язково Рядок Дозволені значення: email , webhook , slack , discord , telegram , microsoft_teams , x , google_chat , internal_notification
email Необов’язково Рядок Доступно, коли: type = email Електронна пошта
webhook Необов’язково Рядок Доступно, коли: type = webhook URL вебхука
slack Необов’язково Рядок Доступно, коли: type = slack URL вебхука Slack
discord Необов’язково Рядок Доступно, коли: type = discord URL вебхука Discord
telegram Необов’язково Рядок Доступно, коли: type = telegram Токен API Telegram
telegram_chat_id Необов’язково Рядок Доступно, коли: type = telegram ID чату Telegram
microsoft_teams Необов’язково Рядок Доступно, коли: type = microsoft_teams URL вебхука Microsoft Teams
google_chat Необов’язково Рядок Доступно, коли: type = google_chat URL вебхука Google Chat
x_consumer_key Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
x_consumer_secret Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
x_access_token Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
x_access_token_secret Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
curl --request POST \
--url 'https://bitpeak.ru/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
{
    "data": {
        "id": 1
    }
}

Оновити

POST https://bitpeak.ru/api/notification-handlers/{notification_handler_id}
Параметри Деталі Опис
name Необов’язково Рядок -
type Необов’язково Рядок Дозволені значення: email , webhook , slack , discord , telegram , microsoft_teams , x , google_chat , internal_notification
email Необов’язково Рядок Доступно, коли: type = email Електронна пошта
webhook Необов’язково Рядок Доступно, коли: type = webhook URL вебхука
slack Необов’язково Рядок Доступно, коли: type = slack URL вебхука Slack
discord Необов’язково Рядок Доступно, коли: type = discord URL вебхука Discord
telegram Необов’язково Рядок Доступно, коли: type = telegram Токен API Telegram
telegram_chat_id Необов’язково Рядок Доступно, коли: type = telegram ID чату Telegram
microsoft_teams Необов’язково Рядок Доступно, коли: type = microsoft_teams URL вебхука Microsoft Teams
google_chat Необов’язково Рядок Доступно, коли: type = google_chat URL вебхука Google Chat
x_consumer_key Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
x_consumer_secret Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
x_access_token Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
x_access_token_secret Необов’язково Рядок Доступно, коли: type = x Токен API Telegram
is_enabled Необов’язково Булеве значення -
curl --request POST \
--url 'https://bitpeak.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
{
    "data": {
        "id": 1
    }
}

Видалити

DELETE https://bitpeak.ru/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://bitpeak.ru/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \