A API possui um webhook que permite ao desenvolvedor receber uma requisição POST automaticamente ao final de cada processo de enriquecimento ou prospecção. Para adicionar a URL, basta registrá-la na edição do perfil do usuário administrador da conta da empresa. Durante o cadastro, será feito um teste automático para verificar a disponibilidade da URL.
Enriquecimento (enrichment)
| Status | Descrição |
|---|---|
requested | Enriquecimento solicitado |
done | Enriquecimento concluído |
error | Erro durante o enriquecimento |
Prospecção (prospecting)
| Status | Descrição |
|---|---|
requested | Prospecção solicitada |
done | Prospecção concluída |
error | Erro durante a prospecção |
AtençãoQuando a conclusão de um serviço (como prospecção ou enriquecimento) ocorrer, a API enviará uma requisição POST para a URL registrada contendo o status do job.
A URL cadastrada deve aceitar requisições do tipo POST e retornar imediatamente o status HTTP 200.
A API fará 3 tentativas, com intervalo de 1 minuto entre cada uma. Cada requisição tem um timeout de 30 segundos.
Tipos de Retorno (Webhook Notification)
| Chave | Tipo / Valores Aceitos | Descrição |
|---|---|---|
job_id | int — Exemplo: 1...n | Identificador único do job |
job_type | string — enrichment ou prospecting | Tipo do processo notificado |
status | string | Status atual do job, de acordo com o tipo |
Valores possíveis para status
statusEnrichment
requesteddoneerror
Prospecting
requesteddoneerror