Enviar notificações

Publica uma notificação em um canal (e, opcionalmente, um tópico). A notificação é entregue à caixa de entrada de todos os usuários que assinam aquele canal/tópico.

Endpoint

POST /api/v1/notifications

Cabeçalhos

Authorization: Bearer SUA_CHAVE
Content-Type: application/json

Corpo

Campo Obrigatório Descrição
canal sim Canal de destino (ex.: financeiro).
titulo sim Título curto da notificação.
topico não Tópico dentro do canal (ex.: nota-rejeitada).
mensagem não Texto com mais detalhes.

Exemplo

curl -X POST https://suaorganizacao.lip.lbhm.com.br/api/v1/notifications \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
        "canal": "financeiro",
        "topico": "nota-rejeitada",
        "titulo": "Nota 123 rejeitada",
        "mensagem": "A prefeitura rejeitou a nota 123. Verifique os dados."
      }'

Resposta

{ "ok": true, "id": 42, "entregues": 5 }
  • id — identificador da notificação criada.
  • entregues — quantos usuários receberam (assinantes do canal/tópico no momento).

Se entregues for 0, ninguém assina esse canal/tópico ainda. Combine com sua equipe os nomes de canais e tópicos e peça que assinem o que interessa.

Erros

Código Significado
401 Chave de API ausente ou inválida.
422 Faltou um campo obrigatório (canal ou titulo).