Cadastrando notificações de evento – Central de Atendimento

A notificação para evento é um serviço de disparo de notificações automáticas por e-mail e/ou SMS. 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.

POST

Homologação:

https://homologacao.plugboleto.com.br/api/v1/eventos/agendamentos

Produção:

https://plugboleto.com.br/api/v1/eventos/agendamentos

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

Objeto

Para cadastrar as notificações de evento, o objeto JSON pode ter os seguintes campos:

Campo	Tipo	Descrição
tipo	Integer	Tipo de evento a ser cadastrado, 1 - Evento de registro 2 - Evento de liquidação 3 - Evento de baixa 4 - Evento de protesto
configuracoes	objeto	Configurações é um objeto para cadastrar o meio do envio da notificação, junto com a mensagem de envio

Campo para cadastro de notificação por E-mail

Campo	Tipo	Descrição
ativo	Boolean	Campo destinado para optar entre ativar ou não o envio da notificação por email, Campo opcional
mensagem	String	Campo destinado para descrever mensagem que será usado no corpo do email, Campo obrigatório Variáveis disponíveis: `${TituloLinhaDigitavel}`, `${TituloNumeroDocumento}`, `${TituloDataVencimento}`, `${SacadoNome}`, `${TituloParcela}`, `${TituloCodigoReferencia}`, `${TituloValor}` e `${linkBoleto}`, está última que envia a tag marcar_visualizado no link de abertura do boleto, de modo que o cedente possa visualizar se o sacado viu o boleto enviado.
assunto	String	Campo destinado para preenchimento do assunto no corpo do email, Campo opcional
cco	Boolean	Campo destinado para ativar o envio da cópia oculta, Campo opcional
cco_email	String	Campo destinado para descrever os endereços de e-mail para onde as cópias ocultas serão enviadas, Campo obrigatório apenas em caso do campo "cco" estiver com true
html	Boolean	Campo destinado para optar entre enviar email como texto ou no formato HTML. Campo opcional

Campo para cadastro de notificação por SMS

Campo	Tipo	Descrição
ativo	Boolean	Campo destinado para optar entre ativar ou não o envio da notificação por email, Campo opcional
mensagem	String	Campo destinado para descrever mensagem que será usado no corpo do SMS, Campo obrigatório

Body

Essa rota recebe no (body) da requisição o tipo de notificação, junto com o campo de configurações onde é descrito as suas configurações de envio de E-mail ou SMS, podendo ser passado as configurações de apenas uma modalidade ou um objeto contendo as configurações de ambos.

Exemplo de JSON:

No exemplo logo abaixo está sendo cadastrado uma notificação de liquidação apenas para E-mail, onde no momento onde o seu boleto passar para a situação liquidado, uma notificação será disparado para endereço de e-mail cadastrado no campo SacadoEmail, que é preenchido durante a inclusão do boleto

{
"tipo":2,
"configuracoes":{
"email":{
"ativo":true,
"mensagem":"Boa tarde seu boleto liquidou"
}
}
}

Agora nesse outro exemplo está sendo cadastrado uma notificação de REGISTRO, e sendo passando as configurações de E-mail e SMS na mesma requisição

{
"tipo":1,
"configuracoes":{
"email":{
"ativo":true,
"cco":true,
"assunto": "Alerta de Liquidação do boleto",
"cco_email":"teste@gmail.com",
"html": true,
"mensagem":"Olá seu boleto acaba de ser Liquidado - E-MAIL"
},
"sms":{
"ativo": true,
"mensagem":"Olá seu boleto acaba de ser Liquidado - SMS"
}
}
}

Também é possível enviar mais de um evento por vez, através de um array montado com todo o payload:

[
  {
    "tipo":1,
    "configuracoes":{
      "email":{
        "ativo":true,
        "mensagem":"Boa tarde seu boleto acaba de ser liquidado"
      }
    }
  },
  {
    "tipo":2,
    "configuracoes":{
      "email":{
        "ativo":true,
        "mensagem":"Boa tarde seu boleto liquidou"
      }
    }
  }
]

Retorno

Exemplo de retorno:

{
_status : 'sucesso',
_mensagem: 'Configurações de eventos atualizadas com sucesso'
}

Exemplo de retorno com erro:

{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "mensagem",
"_erro": "Campo obrigatório."
}
]
}