Обработчики уведомлений
GET https://pushye.com/api/notification-handlers/
curl --request GET \
--url 'https://pushye.com/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://pushye.com/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-02-05 12:57:16"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://pushye.com/api/notification-handlers?&page=1",
"last": "https://pushye.com/api/notification-handlers?&page=1",
"next": null,
"prev": null,
"self": "https://pushye.com/api/notification-handlers?&page=1"
}
}
GET https://pushye.com/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://pushye.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://pushye.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": "2025-02-05 12:57:16"
}
}
POST https://pushye.com/api/notification-handlers
| Параметры | Детали | Описание |
|---|---|---|
| name | Обязательно Строка | - |
| type | Обязательно Строка | Разрешенные значения: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , x , push_subscriber_id |
| Необязательный Строка | Доступно когда: 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 |
| 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 |
| twilio | Необязательный Строка | Доступно когда: type = twilio Номер телефона |
| twilio_call | Необязательный Строка | Доступно когда: type = twilio_call Номер телефона |
| Необязательный Строка | Доступно когда: type = whatsapp Номер телефона |
curl --request POST \
--url 'https://pushye.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://pushye.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://pushye.com/api/notification-handlers/{notification_handler_id}
| Параметры | Детали | Описание |
|---|---|---|
| name | Необязательный Строка | - |
| type | Необязательный Строка | Разрешенные значения: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , x , push_subscriber_id |
| Необязательный Строка | Доступно когда: 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 |
| 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 |
| twilio | Необязательный Строка | Доступно когда: type = twilio Номер телефона |
| twilio_call | Необязательный Строка | Доступно когда: type = twilio_call Номер телефона |
| Необязательный Строка | Доступно когда: type = whatsapp Номер телефона | |
| is_enabled | Необязательный Булевый | - |
curl --request POST \
--url 'https://pushye.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://pushye.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://pushye.com/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://pushye.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://pushye.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \