A notificação para evento é um serviço de disparo de notificações automáticas por e-mail. O disparo é acionado no momento que ocorre a mudança da situação do boleto para as situações de Registro, Liquidação ou Baixa.
GET
Homologação:
https://homologacao.plugboleto.com.br/api/v1/eventos/agendamentos?id=idnotificacao
Produção:
https://plugboleto.com.br/api/v1/eventos/agendamentos?id=idnotificacao
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| cnpj-sh | CNPJ da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": [
{
"id": 9999,
"id_cedente": 11111,
"nome": "Teste",
"assunto": "Agendamento de Teste",
"tipo": "email",
"mensagem": "Prezado(a) Cliente ${SacadoNome}.\n\nNós, da Teste, viemos lembrá-lo(a) que seu boleto ${TituloNumeroDocumento} com vencimento ${TituloDataVencimento} no valor de ${TituloValor} está próximo ao vencimento. Qualquer dúvida ou problema para efetuar o pagamento, entre em contato conosco pelo telefone (99) 99999-9999 ou responda este e-mail.\n\nAgradecemos a preferência e nos colocamos à disposição.\n\nPara visualizar o boleto clique no link: ${linkBoleto}",
"html": false,
"dias_para_vencer": -2,
"cco": true,
"cco_email": {
"email": [
"teste.teste@teste.com.br"
],
"replyTo": "teste.teste@teste.com.br"
},
"protocolo": null,
"criado": "2024-04-12T13:25:10.000Z",
"atualizado": "2024-04-12T13:25:10.000Z"
}
],
"_meta": {
"_itens_por_pagina": 20,
"_paginacao": {
"_proximo": false,
"_anterior": false
},
"_total": 1
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Rota não encontrada.",
"_dados": []
}
Comentários
0 comentário
Por favor, entre para comentar.