JavaScript SDK: Benachrichtigungsreferenz
Jede Methode zum Versenden und Verwalten von Benachrichtigungen mit ihrer Signatur.
6 Min. gelesen·Ebene Referenz·Überarbeitet am 12.10.2026
Dieser englische Text wurde automatisch aus dem französischen Original generiert und wurde noch nicht überprüft.
Diese Seite wurde automatisch übersetzt. Maßgeblich ist die englische Version.
#
Klasse
Benachrichtigungsdienst
| Eigentum | Beschreibung |
|---|---|
readonly admin: NotificationsAdminService | Administrations-Subclient: Statistiken, Warteschlange, Ausschuss (DLQ), Lieferantenprotokolle, Ereignisse, Regeln und Einstellungen. |
| Methode | Beschreibung |
|---|---|
send(options: SendNotificationOptions): Promise<AuraResponse<Notification>>send(channel: NotificationChannel, recipient: string, body: string, options?: { subject?: string; templateId?: string; variables?: Record<string, unknown>; metadata?: Record<string, unknown>; idempotencyKey?: string; }): Promise<AuraResponse<Notification>> | Stellt eine zu sendende Benachrichtigung in die Warteschlange (Modern Object API). |
sendBatch(items: Array<SendNotificationRequest | SendNotificationItem>): Promise<AuraResponse<BatchSendResponse>> | Sendet einen Stapel von Benachrichtigungen (POST /send/batch). |
sendEmail(recipient: string, subject: string, body: string, options?: SendEmailOptions): Promise<AuraResponse<Notification>> | Sendet eine Transaktions-E-Mail (channel: 'email'). |
sendSms(recipient: string, body: string, options?: SendSmsOptions): Promise<AuraResponse<Notification>> | Sendet eine Transaktions-SMS (channel: 'sms'). |
sendPush(recipient: string, title: string, body: string, options?: SendPushOptions): Promise<AuraResponse<Notification>> | Sendet eine mobile Push-Benachrichtigung (channel: 'push', FCM oder APNs). |
sendWebhook(targetUrl: string, event: string, payload: string | Record<string, unknown>, options?: SendWebhookOptions): Promise<AuraResponse<Notification>> | Gibt einen ausgehenden HTTP-POST-Webhook aus (channel: 'webhook'). |
retry(id: string): Promise<AuraResponse<Notification>> | Wiederholen Sie eine fehlgeschlagene Benachrichtigung (status: 'failed' oder 'dead_lettered'). |
list(options?: { channel?: NotificationChannel; status?: NotificationStatus; search?: string; sort?: 'created_at' | 'updated_at' | 'status'; order?: 'asc' | 'desc'; limit?: number; offset?: number; }): Promise<AuraResponse<Notification[]>> | Listet den Benachrichtigungsverlauf des Projekts auf, filterbar nach channel, status und search, sortiert nach created_at, updated_at oder status, mit limit / offset Paginierung. |
get(id: string): Promise<AuraResponse<Notification>> | Liest eine Benachrichtigung anhand ihrer Kennung. |
listTemplates(): Promise<AuraResponse<NotificationTemplate[]>> | Listet die Projektnachrichtenvorlagen auf. |
getTemplate(id: string): Promise<AuraResponse<NotificationTemplate>> | Liest eine Nachrichtenvorlage anhand ihrer Kennung. |
createTemplate(template: Omit<NotificationTemplate, 'id' | 'project_id' | 'created_at' | 'updated_at'>): Promise<AuraResponse<NotificationTemplate>> | Erstellt eine Vorlage – name, channel, subject, body und sonst nichts. |
updateTemplate(id: string, updates: Partial<Pick<NotificationTemplate, 'name' | 'subject' | 'body'>>): Promise<AuraResponse<NotificationTemplate>> | Aktualisiert eine Vorlage: name, subject und/oder body. |
deleteTemplate(id: string): Promise<AuraResponse<null>> | Löscht eine Nachrichtenvorlage. |
#
Klasse
NotificationsAdminService
| Methode | Beschreibung |
|---|---|
getSettings(): Promise<AuraResponse<NotificationSettingsPublic>> | Ruft die öffentlichen Lieferanten- und Kontingenteinstellungen des Projekts ab (GET /settings). |
updateSettings(settings: NotificationSettingsPatch | Partial<NotificationSettings>): Promise<AuraResponse<NotificationSettingsPublic>> | Aktualisiert die Lieferanten- oder Quoteneinstellungen des Projekts (PATCH /settings). |
getStats(options?: { window?: NotificationStatsWindow; channel?: NotificationChannel; }): Promise<AuraResponse<NotificationStats>> | Aggregierte Sendestatistiken (GET /stats). |
getQueue(): Promise<AuraResponse<NotificationQueueStats>> | Liest den Status der Sendewarteschlange: Tiefe und Verteilung ausstehender Benachrichtigungen. |
listAttempts(notificationId: string): Promise<AuraResponse<NotificationAttempt[]>> | Listet Versuche auf, eine Benachrichtigung zu senden, mit der jeweiligen Antwort des Anbieters. |
listDeadLetters(options?: { channel?: NotificationChannel; search?: string; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationDeadLetter[]>> | Listet in der Garbage Queue (DLQ) platzierte Benachrichtigungen auf, filterbar nach channel und search. |
retryDeadLetter(id: string): Promise<AuraResponse<Notification>> | Sendet eine bestimmte Benachrichtigung aus der Scrap-Warteschlange (DLQ) erneut. |
listEvents(options?: { status?: 'received' | 'matched' | 'ignored' | 'failed' | 'enqueued'; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationEvent[]>> | Listet von der Regel-Engine empfangene Ereignisse auf, filterbar nach status. |
listProviderLogs(options?: { channel?: NotificationChannel; status?: NotificationAttemptStatus; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationProviderLog[]>> | Ausführungsprotokolle von Drittanbietern (GET /providers/logs). |
previewTemplate(id: string, variables: Record<string, unknown>): Promise<AuraResponse<NotificationTemplatePreview>> | Rendert ein Modell mit dem angegebenen variables zur Vorschau, ohne eine Nachricht zu senden. |
listRules(): Promise<AuraResponse<NotificationRule[]>> | Listet die Projektbenachrichtigungsregeln (automatisches Auslösen eines Versands) auf. |
createRule(rule: CreateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Erstellt eine Benachrichtigungsregel: Für jedes Ereignis vom Typ trigger_type, das condition überprüft, wird eine Nachricht auf channel an den durch recipient_expr angegebenen Empfänger gesendet, mit einer optionalen Verzögerung. |
getRule(id: string): Promise<AuraResponse<NotificationRule>> | Liest eine Benachrichtigungsregel anhand ihrer Kennung. |
updateRule(id: string, updates: UpdateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Aktualisiert eine Benachrichtigungsregel: Nur die bereitgestellten Felder ändern sich (zum Beispiel enabled). |
deleteRule(id: string): Promise<AuraResponse<null>> | Löscht eine Benachrichtigungsregel. |
Generierte Seite
Diese Seite wird aus den Typdeklarationen und Kommentaren des SDK generiert, sodass sie nicht vom veröffentlichten Code abweichen kann. Ausgearbeitete Beispiele finden Sie in den Leitfäden.
Zuletzt aktualisiert · 12.10.2026