SDK JavaScript: referência de notificações
Todo método de envio e administração de notificações, com sua assinatura.
6 min lido·Nível referência·Revisado em 12 de out. de 2026
Este texto em inglês foi gerado automaticamente a partir do original em francês e ainda não foi revisado.
Esta página foi traduzida automaticamente. A versão em inglês é oficial.
#
Classe
Serviço de Notificações
| Propriedade | Descrição |
|---|---|
readonly admin: NotificationsAdminService | Subcliente de administração: estatísticas, fila, sucata (DLQ), registros de fornecedores, eventos, regras e configurações. |
| Método | Descrição |
|---|---|
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>> | Enfileira uma notificação a ser enviada (API Modern Object). |
sendBatch(items: Array<SendNotificationRequest | SendNotificationItem>): Promise<AuraResponse<BatchSendResponse>> | Envia um lote de notificações (POST /send/batch). |
sendEmail(recipient: string, subject: string, body: string, options?: SendEmailOptions): Promise<AuraResponse<Notification>> | Envia um email transacional (channel: 'email'). |
sendSms(recipient: string, body: string, options?: SendSmsOptions): Promise<AuraResponse<Notification>> | Envia um SMS transacional (channel: 'sms'). |
sendPush(recipient: string, title: string, body: string, options?: SendPushOptions): Promise<AuraResponse<Notification>> | Envia uma notificação push móvel (channel: 'push', FCM ou APNs). |
sendWebhook(targetUrl: string, event: string, payload: string | Record<string, unknown>, options?: SendWebhookOptions): Promise<AuraResponse<Notification>> | Emite um webhook HTTP POST de saída (channel: 'webhook'). |
retry(id: string): Promise<AuraResponse<Notification>> | Tente novamente uma notificação com falha (status: 'failed' ou '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[]>> | Lista o histórico de notificações do projeto, filtrável por channel, status e search, classificado por created_at, updated_at ou status, com paginação limit / offset . |
get(id: string): Promise<AuraResponse<Notification>> | Lê uma notificação pelo seu identificador. |
listTemplates(): Promise<AuraResponse<NotificationTemplate[]>> | Lista os modelos de mensagens do projeto. |
getTemplate(id: string): Promise<AuraResponse<NotificationTemplate>> | Lê um modelo de mensagem pelo seu identificador. |
createTemplate(template: Omit<NotificationTemplate, 'id' | 'project_id' | 'created_at' | 'updated_at'>): Promise<AuraResponse<NotificationTemplate>> | Cria um modelo — name, channel, subject, body e nada mais. |
updateTemplate(id: string, updates: Partial<Pick<NotificationTemplate, 'name' | 'subject' | 'body'>>): Promise<AuraResponse<NotificationTemplate>> | Atualiza um modelo: name, subject e/ou body. |
deleteTemplate(id: string): Promise<AuraResponse<null>> | Exclui um modelo de mensagem. |
#
Classe
NotificaçõesAdminService
| Método | Descrição |
|---|---|
getSettings(): Promise<AuraResponse<NotificationSettingsPublic>> | Recupera o fornecedor público e as configurações de cota do projeto (GET /settings). |
updateSettings(settings: NotificationSettingsPatch | Partial<NotificationSettings>): Promise<AuraResponse<NotificationSettingsPublic>> | Atualiza as configurações de fornecedor ou cota do projeto (PATCH /settings). |
getStats(options?: { window?: NotificationStatsWindow; channel?: NotificationChannel; }): Promise<AuraResponse<NotificationStats>> | Estatísticas de envio agregadas (GET /stats). |
getQueue(): Promise<AuraResponse<NotificationQueueStats>> | Lê o status da fila de envio: profundidade e distribuição de notificações pendentes. |
listAttempts(notificationId: string): Promise<AuraResponse<NotificationAttempt[]>> | Lista as tentativas de envio de uma notificação, com a resposta do provedor a cada uma. |
listDeadLetters(options?: { channel?: NotificationChannel; search?: string; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationDeadLetter[]>> | Lista notificações colocadas na fila de lixo (DLQ), filtráveis por channel e search. |
retryDeadLetter(id: string): Promise<AuraResponse<Notification>> | Reenvia uma notificação específica da fila de descarte (DLQ). |
listEvents(options?: { status?: 'received' | 'matched' | 'ignored' | 'failed' | 'enqueued'; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationEvent[]>> | Lista eventos recebidos pelo mecanismo de regras, filtráveis por status. |
listProviderLogs(options?: { channel?: NotificationChannel; status?: NotificationAttemptStatus; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationProviderLog[]>> | Logs de execução de fornecedores terceirizados (GET /providers/logs). |
previewTemplate(id: string, variables: Record<string, unknown>): Promise<AuraResponse<NotificationTemplatePreview>> | Renderiza um modelo com o variables fornecido para visualização, sem enviar mensagem. |
listRules(): Promise<AuraResponse<NotificationRule[]>> | Lista as regras de notificação do projeto (acionamento automático de um envio). |
createRule(rule: CreateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Cria uma regra de notificação: para cada evento do tipo trigger_type que verifica condition, uma mensagem é enviada em channel para o destinatário fornecido por recipient_expr, com atraso opcional. |
getRule(id: string): Promise<AuraResponse<NotificationRule>> | Lê uma regra de notificação pelo seu identificador. |
updateRule(id: string, updates: UpdateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Atualiza uma regra de notificação: apenas os campos fornecidos são alterados (por exemplo enabled). |
deleteRule(id: string): Promise<AuraResponse<null>> | Exclui uma regra de notificação. |
Página gerada
Esta página é gerada a partir das declarações de tipo e comentários do SDK, portanto, não pode desviar do código publicado. Para exemplos resolvidos, leia os guias.
Última atualização · 12 de out. de 2026