通知ハンドラー
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 | オプション 整数 | 1ページあたりの結果数はどのくらいにしますか。許可されている値は：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 15:02:00"
}
],
"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 15:02:00"
}
}
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 Webhook URL |
| slack | オプション 文字列 | 利用可能な時期: type = slack SlackウェブフックURL |
| discord | オプション 文字列 | 利用可能な時期: type = discord DiscordウェブフックURL |
| telegram | オプション 文字列 | 利用可能な時期: type = telegram Telegram APIトークン |
| telegram_chat_id | オプション 文字列 | 利用可能な時期: type = telegram TelegramチャットID |
| x_consumer_key | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| x_consumer_secret | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| x_access_token | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| x_access_token_secret | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| 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 Webhook URL |
| slack | オプション 文字列 | 利用可能な時期: type = slack SlackウェブフックURL |
| discord | オプション 文字列 | 利用可能な時期: type = discord DiscordウェブフックURL |
| telegram | オプション 文字列 | 利用可能な時期: type = telegram Telegram APIトークン |
| telegram_chat_id | オプション 文字列 | 利用可能な時期: type = telegram TelegramチャットID |
| x_consumer_key | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| x_consumer_secret | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| x_access_token | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| x_access_token_secret | オプション 文字列 | 利用可能な時期: type = x Telegram APIトークン |
| 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}' \