Bem vindo a documentação da IDwall

Aqui você vai encontrar tudo que precisa para integrar o seu sistema com a nossa API

Start here!

Webhooks

Organizations can have a WebHook setup and IDwall will send a POST request when events occur.

You can change your WebHook URL in the settings of your organization through the settings on your Dashboard.

Retries

We'll by default retry the webhook 5 times if the request fails. We assume a request fails when the HTTP status returned by the server isn't between the range of 200 through 399 or if the request timeout after 5 seconds.

Return Pattern

All the requests are sent as POST methods with application/json as the Content-Type with this pattern:

{
    "dados": {},
    "tipo": "{event-type}"
}
  • tipo: the type of event related to this request. All the possible events are listed below.
  • dados: the details of the event. The contents of this event depend on the event type.

Event Types

protocolo_status

Sent when the status of a report changed. More details about this in Report Status (PT-BR).

Example
{ 
    "dados": {
        "protocolo": "{report_number}",
        "status": "{report_status}"
    }, 
    "tipo": "protocolo_status" 
}

with report number being the UUID (00000000-0000-0000-0000-0000000000000) of the report.

These are the report_status possibilities you can receive:
PENDENTE
EM ANALISE
PROCESSANDO
CONCLUIDO


What's Next

Status