Notifikationshanterare
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}' \
| Parametrar | Detaljer | Beskrivning |
|---|---|---|
| page | Valfritt Heltal | Sidanummeret som du vill ha resultat från. Standardinställning är 1. |
| results_per_page | Valfritt Heltal | Hur många resultat vill du ha per sida. Tillåtna värden är: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Standardvärde är 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:47:33"
}
],
"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:47:33"
}
}
POST https://pushye.com/api/notification-handlers
| Parametrar | Detaljer | Beskrivning |
|---|---|---|
| name | Obligatoriskt Sträng | - |
| type | Obligatoriskt Sträng | Tillåtna värden: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , x , push_subscriber_id |
| Valfritt Sträng | Tillgänglig när: type = email E-post | |
| webhook | Valfritt Sträng | Tillgänglig när: type = webhook Webhook-URL |
| slack | Valfritt Sträng | Tillgänglig när: type = slack Slack webhook-URL |
| discord | Valfritt Sträng | Tillgänglig när: type = discord Discord webhook-URL |
| telegram | Valfritt Sträng | Tillgänglig när: type = telegram Telegram API-token |
| telegram_chat_id | Valfritt Sträng | Tillgänglig när: type = telegram Telegram Chat-ID |
| x_consumer_key | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| x_consumer_secret | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| x_access_token | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| x_access_token_secret | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| twilio | Valfritt Sträng | Tillgänglig när: type = twilio Telefonnummer |
| twilio_call | Valfritt Sträng | Tillgänglig när: type = twilio_call Telefonnummer |
| Valfritt Sträng | Tillgänglig när: type = whatsapp Telefonnummer |
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}
| Parametrar | Detaljer | Beskrivning |
|---|---|---|
| name | Valfritt Sträng | - |
| type | Valfritt Sträng | Tillåtna värden: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , x , push_subscriber_id |
| Valfritt Sträng | Tillgänglig när: type = email E-post | |
| webhook | Valfritt Sträng | Tillgänglig när: type = webhook Webhook-URL |
| slack | Valfritt Sträng | Tillgänglig när: type = slack Slack webhook-URL |
| discord | Valfritt Sträng | Tillgänglig när: type = discord Discord webhook-URL |
| telegram | Valfritt Sträng | Tillgänglig när: type = telegram Telegram API-token |
| telegram_chat_id | Valfritt Sträng | Tillgänglig när: type = telegram Telegram Chat-ID |
| x_consumer_key | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| x_consumer_secret | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| x_access_token | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| x_access_token_secret | Valfritt Sträng | Tillgänglig när: type = x Telegram API-token |
| twilio | Valfritt Sträng | Tillgänglig när: type = twilio Telefonnummer |
| twilio_call | Valfritt Sträng | Tillgänglig när: type = twilio_call Telefonnummer |
| Valfritt Sträng | Tillgänglig när: type = whatsapp Telefonnummer | |
| is_enabled | Valfritt Boolean | - |
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}' \