Benachrichtigungs-Handler
GET https://push.hallo-webseite.de/api/notification-handlers/
curl --request GET \
--url 'https://push.hallo-webseite.de/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.hallo-webseite.de/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Parameter | Einzelheiten | Beschreibung |
---|---|---|
page | Optional Ganze Zahl | Die Seitenzahl, von der du Ergebnisse möchtest. Standardmäßig auf 1 gesetzt. |
results_per_page | Optional Ganze Zahl | Wie viele Ergebnisse möchten Sie pro Seite sehen. Erlaubte Werte sind: 10 , 25 , 50 , 100 , 250 , 500 , 1000 . Standardmäßig auf 25 gesetzt. |
{
"data": [
{
"id": 1,
"type": "email",
"name": "Work email",
"settings": {
"email": "hey@example.com"
},
"is_enabled": true,
"last_datetime": null,
"datetime": "2025-03-09 22:32:46"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://push.hallo-webseite.de/api/notification-handlers?&page=1",
"last": "https://push.hallo-webseite.de/api/notification-handlers?&page=1",
"next": null,
"prev": null,
"self": "https://push.hallo-webseite.de/api/notification-handlers?&page=1"
}
}
GET https://push.hallo-webseite.de/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://push.hallo-webseite.de/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.hallo-webseite.de/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-03-09 22:32:46"
}
}
POST https://push.hallo-webseite.de/api/notification-handlers
Parameter | Einzelheiten | Beschreibung |
---|---|---|
name | Erforderlich Zeichenkette | - |
type | Erforderlich Zeichenkette | Erlaubte Werte: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , x , push_subscriber_id |
Optional Zeichenkette | Verfügbar, wenn: type = email E-Mail | |
webhook | Optional Zeichenkette | Verfügbar, wenn: type = webhook Webhook-URL |
slack | Optional Zeichenkette | Verfügbar, wenn: type = slack Slack-Webhook-URL |
discord | Optional Zeichenkette | Verfügbar, wenn: type = discord Discord-Webhook-URL |
telegram | Optional Zeichenkette | Verfügbar, wenn: type = telegram Telegram API Token |
telegram_chat_id | Optional Zeichenkette | Verfügbar, wenn: type = telegram Telegram Chat ID |
x_consumer_key | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
x_consumer_secret | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
x_access_token | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
x_access_token_secret | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
twilio | Optional Zeichenkette | Verfügbar, wenn: type = twilio Telefonnummer |
twilio_call | Optional Zeichenkette | Verfügbar, wenn: type = twilio_call Telefonnummer |
Optional Zeichenkette | Verfügbar, wenn: type = whatsapp Telefonnummer |
curl --request POST \
--url 'https://push.hallo-webseite.de/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://push.hallo-webseite.de/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://push.hallo-webseite.de/api/notification-handlers/{notification_handler_id}
Parameter | Einzelheiten | Beschreibung |
---|---|---|
name | Optional Zeichenkette | - |
type | Optional Zeichenkette | Erlaubte Werte: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , x , push_subscriber_id |
Optional Zeichenkette | Verfügbar, wenn: type = email E-Mail | |
webhook | Optional Zeichenkette | Verfügbar, wenn: type = webhook Webhook-URL |
slack | Optional Zeichenkette | Verfügbar, wenn: type = slack Slack-Webhook-URL |
discord | Optional Zeichenkette | Verfügbar, wenn: type = discord Discord-Webhook-URL |
telegram | Optional Zeichenkette | Verfügbar, wenn: type = telegram Telegram API Token |
telegram_chat_id | Optional Zeichenkette | Verfügbar, wenn: type = telegram Telegram Chat ID |
x_consumer_key | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
x_consumer_secret | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
x_access_token | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
x_access_token_secret | Optional Zeichenkette | Verfügbar, wenn: type = x Telegram API Token |
twilio | Optional Zeichenkette | Verfügbar, wenn: type = twilio Telefonnummer |
twilio_call | Optional Zeichenkette | Verfügbar, wenn: type = twilio_call Telefonnummer |
Optional Zeichenkette | Verfügbar, wenn: type = whatsapp Telefonnummer | |
is_enabled | Optional Boolean | - |
curl --request POST \
--url 'https://push.hallo-webseite.de/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://push.hallo-webseite.de/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://push.hallo-webseite.de/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://push.hallo-webseite.de/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://push.hallo-webseite.de/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \