Notificações

Notificações são Callbacks/Webhooks enviados ao cliente sempre que o pedido de registro for atualizado.

Atualmente, é possível receber notificações para os tipos descritos abaixo:

  • ENVIO_AVISO_ASSINATURA

    • Disparado sempre que uma assinatura for realizada.

  • ENVIO_PROTOCOLO_CARTORIO

    • Disparado quando o pedido for enviado ao cartório.

  • ENVIO_VALORES_CUSTAS

    • Disparado quando as custas cartorárias forem adicionadas ao pedido.

  • ENVIO_NOTA_DEBITO

    • Disparado na geração da Nota de Débito.

  • ENVIO_EXIGENCIAS

    • Disparado quando houver uma exigência para o pedido.

  • ENVIO_EVENTOS_STATUS

    • Disparado sempre que houver alteração no status do pedido.

  • ENVIO_REGISTRO_CLIENTE

    • Disparado ao final do processo, quando o pedido for registrado, com todos os arquivos gerados durante o processo.

Exemplos

{
   "tipo":"ENVIO_AVISO_ASSINATURA",
   "dados":{
      "cnpj":"58066124000150",
      "idPedidoCliente":"96868571",
      "idPedidoCdx":"3614",
      "nomeSignatario":"Steve Rogers",
      "qualificacaoSignatario":"ASSINADOR",
      "dataHoraEvento":"2022-08-25 16:46:05",
      "statusEvento":"ASSINADO"
   }
}
{
   "tipo":"ENVIO_PROTOCOLO_CARTORIO",
   "dados":{
      "cnpj":"52072332000185",
      "idPedidoCdx":"3266",
      "idPedidoCliente": "96868571",
      "ufCartorio":"GO",
      "cidadeCartorio":"Goiânia",
      "nomeCartorio":"OFÍCIO DE REGISTRO DE IMÓVEIS DA 1ª CIRCUNSCRIÇÃO",
      "numeroPrenotacao":"10111213141516171819",
      "dataPrenotacao":"2022-08-25",
      "dataVencimentoPrenotacao":"2022-08-26",
      "dataRespostaRI":"2022-08-27",
      "respostaRI":"Texto contendo Resposta do Registro"
   }
}
{
   "tipo":"ENVIO_VALORES_CUSTAS",
   "dados":{
      "cnpj":"58066124000150",
      "idPedidoCdx": "3266",
      "idPedidoCliente": "96868571",
      "numeroPrenotacao":"43543135",
      "valorCustas": 100.0
   }
}
{
   "tipo":"ENVIO_NOTA_DEBITO",
   "dados":{
      "cnpj":"58066124000150",
      "idPedidoCdx": "3266",
      "idPedidoCliente": "96868571",
      "numeroPrenotacao":"43543135",
      "notaDebito":"https://exemplo.com/nota-debito.pdf"
   }
}
{
   "tipo":"ENVIO_EXIGENCIAS",
   "dados":{
      "cnpj":"58066124000150",
      "idPedidoCdx":"3614",
      "idPedidoCliente":"96868571",
      "numeroPrenotacao":"1231333",
      "dataExigencia":"2022-08-25 17:01:59",
      "descricaoExigencia":"Descrição da Exigência",
      "documentoExigencia":"https://exemplo.com/exigencia.pdf"
   }
}
{
   "tipo":"ENVIO_EVENTOS_STATUS",
   "dados":{
      "cnpj":"58066124000150",
      "idPedidoCdx":"3614",
      "idPedidoCliente":"96868571",
      "idEvento":"NOVO_PEDIDO"
   }
}
{
   "tipo":"ENVIO_REGISTRO_CLIENTE",
   "dados":{
      "cnpj":"58066124000150",
      "idPedidoCdx":"3614",
      "idPedidoCliente":"96868571",
      "numeroPrenotacao":"43543135",
      "dataRegistro":"2022-08-25",
      "descricaoRetornoRI":"Funções André Mello",
      "urlDocumentos":[
         "https://exemplo.com/rsposta.pdf",
         "https://exemplo.com/recibo.pdf",
         "https://exemplo.com/documento-assinado.pdf"
      ]
   }
}

Last updated