Webhooks

Atualize o seu sistema em tempo real com os webhooks. Eles permitem que as implementações recebam mensagens quando determinados eventos ocorrem, através de uma requisição HTTP POST, para uma URL pre-determinada.

Um exemplo de utilização é o Background Check. Após a solicitação da análise de Pessoa ou Empresa, seu sistema recebe um número de protocolo informando que a validação entrou na fila de processamento. Esta pode demorar alguns segundos para ser concluída. Com o webhook, seu sistema recebe uma chamada HTTP POST em uma URL cadastrada na IDwall quando o Background Check referente a este protocolo for concluído.

Você pode utilizar os webhooks para:

  • Protocolo começou a ser processado
  • Protocolo terminou de ser processado
  • Protocolo foi para análise
  • Uma etapa do processamento do protocolo foi concluída

Configurando URLs de recebimento

Para cadastrar uma nova URL de recebimento, entre em contato com nossa equipe no email suporte@idwall.co.

Recebendo um webhook

A seguir, um exemplo de requisição enviada pela IDwall para sua URL de recebimento. Esta é uma requisição recebida quando um protocolo começa a ser processado:

{
  "usuario" : "0e8c7893-1207-49bd-b0a3-fe0a376c8c35",
  "criadoEm" : "2016-09-01T01:24:17.813",
  "evento" : "PROTOCOLO_PROCESSANDO",
  "mensagem" : "O Protocolo começou a ser processado",
  "data" : {
    "atualizadoEm": "2016-09-01T01:24:17.813",
    "criadoEm": "2016-08-11T03:55:16.076Z",
    "entidadeId": "26174886832",
    "entidadeTipo": "pessoa",
    "matriz": "consultaPessoaDefault",
    "numero": "06142199-ff0a-4749-be4e-dce6d02aeee9",
    "parametros": {
      "cpf": "87299377820",
      "dataDeNascimento": "04/02/1979",
      "nome": "Renato Oliveira de Souza"
    },
    "situacao": "PROCESSANDO",
    "usuario": "0e8c7893-1207-49bd-b0a3-fe0a376c8c35"
  }
}

Veja abaixo a lista de eventos que ativam o webhook.

Código Descrição
PROTOCOLO_PROCESSANDO Protocolo começou a ser processado
PROTOCOLO_CONCLUIDO Protocolo terminou de ser processado
PROTOCOLO_EM_ANALISE Protocolo foi para análise
CONSULTA_CONCLUIDO Uma etapa do processamento do protocolo foi concluída

A IDwall ainda não tem implementada a retentativa de entrega, portanto a requisição é enviada apenas uma vez, mesmo se o seu sistema apresentar um erro ao recebê-la.