Обработчики уведомлений
GET https://birbshare.com/api/notification-handler/
curl --request GET \
--url 'https://birbshare.com/api/notification-handler/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://birbshare.com/api/notification-handler/' \
--header 'Authorization: Bearer {api_key}' \
| Параметры | Details | Description |
|---|---|---|
| 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": "2021-06-27 22:16:23"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://birbshare.com/api/notification-handler?&page=1",
"last": "https://birbshare.com/api/notification-handler?&page=1",
"next": null,
"prev": null,
"self": "https://birbshare.com/api/notification-handler?&page=1"
}
}
GET https://birbshare.com/api/notification-handler/{notification_handler_id}
curl --request GET \
--url 'https://birbshare.com/api/notification-handler/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://birbshare.com/api/notification-handler/{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": "2021-06-27 22:16:23"
}
}
POST https://birbshare.com/api/notification-handlers
| Параметры | Details | Description |
|---|---|---|
| name | Требуется Строка | - |
| type | Требуется Строка | Допустимые значения: email , webhook , slack , discord , telegram , microsoft_teams |
| Дополнительно Строка | Available when: type = email Электронная почта | |
| webhook | Дополнительно Строка | Available when: type = webhook URL вебхука |
| slack | Дополнительно Строка | Available when: type = slack URL вебхука Slack |
| discord | Дополнительно Строка | Available when: type = discord URL вебхука Discord |
| telegram | Дополнительно Строка | Available when: type = telegram Токен API Telegram |
| telegram_chat_id | Дополнительно Строка | Available when: type = telegram Идентификатор чата в Telegram |
curl --request POST \
--url 'https://birbshare.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' \
--url 'https://birbshare.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://birbshare.com/api/notification-handlers/{notification_handler_id}
| Параметры | Details | Description |
|---|---|---|
| name | Дополнительно Строка | - |
| type | Дополнительно Строка | Допустимые значения: email , webhook , slack , discord , telegram , microsoft_teams |
| Дополнительно Строка | Available when: type = email Электронная почта | |
| webhook | Дополнительно Строка | Available when: type = webhook URL вебхука |
| slack | Дополнительно Строка | Available when: type = slack URL вебхука Slack |
| discord | Дополнительно Строка | Available when: type = discord URL вебхука Discord |
| telegram | Дополнительно Строка | Available when: type = telegram Токен API Telegram |
| telegram_chat_id | Дополнительно Строка | Available when: type = telegram Идентификатор чата в Telegram |
| is_enabled | Дополнительно Булево значение | - |
curl --request POST \
--url 'https://birbshare.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' \
--url 'https://birbshare.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://birbshare.com/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://birbshare.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://birbshare.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \