Обработчики уведомлений

Получить все

GET https://biolink.farelix.com/api/notification-handlers/
curl --request GET \
--url 'https://biolink.farelix.com/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Подробности Описание
search Необязательно Строка Строка поиска.
search_by Необязательно Строка По какому полю вы ищете. Допустимые значения: name.
is_enabled Необязательно логическое значение
type Необязательно Строка По какому полю вы ищете. Допустимые значения: email, webhook, slack, discord, telegram, microsoft_teams, ntfy.
datetime_field Необязательно Строка Допустимые значения: datetime, last_datetime
datetime_start Необязательно Строка Фильтровать результаты, начиная с этой даты и времени. Формат Г-м-д ч:и:сек.
datetime_end Необязательно Строка Отфильтровать результаты до этой даты и времени. Формат Г-м-д ч:и:сек.
order_by Необязательно Строка По какому полю упорядочить результаты. Допустимые значения: notification_handler_id, datetime, last_datetime, name.
order_type Необязательно Строка Упорядочение результатов. Допустимые значения: ASC для сортировки по возрастанию и DESC для сортировки по убыванию.
search Необязательно Строка Строка поиска.
search_by Необязательно Строка По какому полю вы ищете. Допустимые значения: name.
is_enabled Необязательно логическое значение
type Необязательно Строка По какому полю вы ищете. Допустимые значения: email, webhook, slack, discord, telegram, microsoft_teams, ntfy.
datetime_field Необязательно Строка Допустимые значения: datetime, last_datetime
datetime_start Необязательно Строка Фильтровать результаты, начиная с этой даты и времени. Формат Г-м-д ч:и:сек.
datetime_end Необязательно Строка Отфильтровать результаты до этой даты и времени. Формат Г-м-д ч:и:сек.
order_by Необязательно Строка По какому полю упорядочить результаты. Допустимые значения: notification_handler_id, datetime, last_datetime, name.
order_type Необязательно Строка Упорядочение результатов. Допустимые значения: ASC для сортировки по возрастанию и DESC для сортировки по убыванию.
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": "2026-11-04 01:22:02",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://biolink.farelix.com/api/notification-handlers?page=1",
        "last": "https://biolink.farelix.com/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://biolink.farelix.com/api/notification-handlers?page=1"
    }
}

Получить один

GET https://biolink.farelix.com/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://biolink.farelix.com/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": "2026-11-04 01:22:02",
    }
}

Создать

POST https://biolink.farelix.com/api/notification-handlers
Параметры Подробности Описание
name Требуется Строка -
type Требуется Строка Допустимые значения: email, webhook, slack, discord, telegram, microsoft_teams, ntfy
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 Идентификатор чата Telegram
microsoft_teams Необязательно Строка Доступно, когда: type = microsoft_teams URL-адрес веб-перехватчика Microsoft Teams
ntfy Необязательно Строка Доступно, когда: type = ntfy URL темы ntfy
curl --request POST \
--url 'https://biolink.farelix.com/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://biolink.farelix.com/api/notification-handlers/{notification_handler_id}
Параметры Подробности Описание
name Необязательно Строка -
type Необязательно Строка Допустимые значения: email, webhook, slack, discord, telegram, microsoft_teams, ntfy
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 Идентификатор чата Telegram
microsoft_teams Необязательно Строка Доступно, когда: type = microsoft_teams URL-адрес веб-перехватчика Microsoft Teams
ntfy Необязательно Строка Доступно, когда: type = ntfy URL темы ntfy
is_enabled Необязательно логическое значение -
curl --request POST \
--url 'https://biolink.farelix.com/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://biolink.farelix.com/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://biolink.farelix.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \