Benachrichtigungs-Handler

Alle abrufen

GET https://app.jog690.link/api/notification-handlers/
curl --request GET \
--url 'https://app.jog690.link/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Parameter Details Beschreibung
search Optional Zeichenfolge Der Suchbegriff.
search_by Optional Zeichenfolge Nach welchem Feld suchen Sie? Zulässige Werte sind: name.
is_enabled Optional Boolesch
type Optional Zeichenfolge Nach welchem Feld suchen Sie? Zulässige Werte sind: email, webhook, slack, discord, telegram, microsoft_teams, x, google_chat, ntfy, internal_notification.
datetime_field Optional Zeichenfolge Erlaubte Werte: datetime, last_datetime
datetime_start Optional Zeichenfolge Filterergebnisse beginnend ab diesem Datum und dieser Uhrzeit. Y-m-d H:i:s Format.
datetime_end Optional Zeichenfolge Ergebnisse bis zu diesem Datum und dieser Uhrzeit filtern. Y-m-d H:i:s Format.
order_by Optional Zeichenfolge Nach welchem Feld die Ergebnisse sortiert werden sollen. Zulässige Werte sind: notification_handler_id, datetime, last_datetime, name.
order_type Optional Zeichenfolge Die Reihenfolge der Ergebnisse. Zulässige Werte sind: ASC für aufsteigende Reihenfolge und DESC für absteigende Reihenfolge.
search Optional Zeichenfolge Der Suchbegriff.
search_by Optional Zeichenfolge Nach welchem Feld suchen Sie? Zulässige Werte sind: name.
is_enabled Optional Boolesch
type Optional Zeichenfolge Nach welchem Feld suchen Sie? Zulässige Werte sind: email, webhook, slack, discord, telegram, microsoft_teams, x, google_chat, ntfy, internal_notification.
datetime_field Optional Zeichenfolge Erlaubte Werte: datetime, last_datetime
datetime_start Optional Zeichenfolge Filterergebnisse beginnend ab diesem Datum und dieser Uhrzeit. Y-m-d H:i:s Format.
datetime_end Optional Zeichenfolge Ergebnisse bis zu diesem Datum und dieser Uhrzeit filtern. Y-m-d H:i:s Format.
order_by Optional Zeichenfolge Nach welchem Feld die Ergebnisse sortiert werden sollen. Zulässige Werte sind: notification_handler_id, datetime, last_datetime, name.
order_type Optional Zeichenfolge Die Reihenfolge der Ergebnisse. Zulässige Werte sind: ASC für aufsteigende Reihenfolge und DESC für absteigende Reihenfolge.
page Optional Ganzzahl Die Seitennummer, von der Sie Ergebnisse erhalten möchten. Standardmäßig 1.
results_per_page Optional Ganzzahl Wie viele Ergebnisse möchten Sie pro Seite anzeigen. Erlaubte Werte sind: 10, 25, 50, 100, 250, 500, 1000. Standardmäßig ist 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "type": "email",
            "name": "Work email",
            "settings": {
                "email": "[email protected]"
            },
            "is_enabled": 1,
            "last_datetime": null,
            "datetime": "2026-11-03 20:53:10"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://app.jog690.link/api/notification-handlers?page=1",
        "last": "https://app.jog690.link/api/notification-handlers?page=1",
        "next": null,
        "prev": null,
        "self": "https://app.jog690.link/api/notification-handlers?page=1"
    }
}

Einen abrufen

GET https://app.jog690.link/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://app.jog690.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "[email protected]"
        },
        "is_enabled": 1,
        "last_datetime": null,
        "datetime": "2026-11-03 20:53:10"
    }
}

Erstellen

POST https://app.jog690.link/api/notification-handlers
Parameter Details Beschreibung
name Erforderlich Zeichenfolge -
type Erforderlich Zeichenfolge Erlaubte Werte: email, webhook, slack, discord, telegram, microsoft_teams, x, google_chat, ntfy, internal_notification
email Optional Zeichenfolge Verfügbar wenn: type = email E-Mail
webhook Optional Zeichenfolge Verfügbar wenn: type = webhook Webhook-URL
slack Optional Zeichenfolge Verfügbar wenn: type = slack Slack Webhook-URL
discord Optional Zeichenfolge Verfügbar wenn: type = discord Discord-Webhook-URL
telegram Optional Zeichenfolge Verfügbar wenn: type = telegram Telegram-API-Token
telegram_chat_id Optional Zeichenfolge Verfügbar wenn: type = telegram Telegram-Chat-ID
microsoft_teams Optional Zeichenfolge Verfügbar wenn: type = microsoft_teams Microsoft Teams Webhook-URL
google_chat Optional Zeichenfolge Verfügbar wenn: type = google_chat Google Chat Webhook-URL
ntfy Optional Zeichenfolge Verfügbar wenn: type = ntfy ntfy Thema URL
x_consumer_key Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
x_consumer_secret Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
x_access_token Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
x_access_token_secret Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
curl --request POST \
--url 'https://app.jog690.link/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=[email protected]' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "[email protected]"
        },
        "is_enabled": 1,
        "last_datetime": null,
        "datetime": "2026-11-03 20:53:10"
    }
}

Aktualisieren

POST https://app.jog690.link/api/notification-handlers/{notification_handler_id}
Parameter Details Beschreibung
name Optional Zeichenfolge -
type Optional Zeichenfolge Erlaubte Werte: email, webhook, slack, discord, telegram, microsoft_teams, x, google_chat, ntfy, internal_notification
email Optional Zeichenfolge Verfügbar wenn: type = email E-Mail
webhook Optional Zeichenfolge Verfügbar wenn: type = webhook Webhook-URL
slack Optional Zeichenfolge Verfügbar wenn: type = slack Slack Webhook-URL
discord Optional Zeichenfolge Verfügbar wenn: type = discord Discord-Webhook-URL
telegram Optional Zeichenfolge Verfügbar wenn: type = telegram Telegram-API-Token
telegram_chat_id Optional Zeichenfolge Verfügbar wenn: type = telegram Telegram-Chat-ID
microsoft_teams Optional Zeichenfolge Verfügbar wenn: type = microsoft_teams Microsoft Teams Webhook-URL
google_chat Optional Zeichenfolge Verfügbar wenn: type = google_chat Google Chat Webhook-URL
ntfy Optional Zeichenfolge Verfügbar wenn: type = ntfy ntfy Thema URL
x_consumer_key Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
x_consumer_secret Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
x_access_token Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
x_access_token_secret Optional Zeichenfolge Verfügbar wenn: type = x Telegram-API-Token
is_enabled Optional Boolesch -
curl --request POST \
--url 'https://app.jog690.link/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,
        "user_id": 1,
        "type": "email",
        "name": "Example new name",
        "settings": {
            "email": "[email protected]"
        },
        "is_enabled": 1,
        "last_datetime": "2026-11-03 20:53:10",
        "datetime": "2026-11-03 20:53:10"
    }
}

Löschen

DELETE https://app.jog690.link/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://app.jog690.link/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \