Notificação Webhook

O processamento da transação da DeviceCheck ocorre de forma assíncrona, sendo necessário receber notificações através de um webhook.
O webhook enviará automaticamente uma notificação após os processamentos dos insights.

Configuração do Webhook

Para configurar o webhook, siga os passos abaixo:

Crie um endpoint para recebimento das notificações.
Certifique-se de que este endpoint aceita requisições do tipo POST.
Forneça "Nome Fantasia Cliente" e a "URL" do endpoint criado para a equipe responsável através do atendimento: [email protected].

Response

O webhook enviará um payload conforme o exemplo abaixo:

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "externalID": 82309203,
    "deviceID": "25432df56bf24f15hd928374",
    "insights": [
        "DEV0002",
        "DEV0007",
        "DEV0500",
        "GER2450",
        "GER2448",
        "GER2405",
        "GER2471",
        "GER2474"
    ],
    "alertQuantity": 0,
    "similarityResult": {
        "deviceID": "25432df56bf24f15hd928374",
        "maximumScore": [
            0.9614484590856165
        ],
        "similarDevices": [
            "25432df56bf24f15hd928374",
            "6384118b7016ba14b42221be"
        ]
    },
    "events": [101, 102, 103],
    "status": "success", //também pode retornar "partial" ou "failure"
    "requestID": "req-1234567890"
}

Dicionário de Variáveis

Response

Nome	Descrição	Tipo
ExternalID	Identificador único da transação do integrador.	String
DeviceID	Identificador único do dispositivo.	String
Insights	Insights com base no histórico das informações do dispositivo e os demais dados enviados na requisição.	List<String>
AlertQuantity	Quantidade de alertas detectados a partir do retorno dos insights.	Int
SimilarityResult	Lista de objetos contendo os dados de similaridade. Em caso de um novo identificador do dispositivo (DeviceID), a similaridade retorna se existe algum device que possua características similares ao dispositivo e dados da transação.	Similarity Result
Events	Retorno dos eventos realizados pelo dispositivo. Para este retorno é necessário ter os eventos integrados.	List<Int>
Status	Status do processamento das informações que serão enviadas via webhook. Os status podem ser "Success", "Partial" ou "Failure"	String
RequestID	Identificador transacional da DeviceCheck.	String

Similarity Result

Nome	Descrição	Tipo
DeviceID	Identificador único do dispositivo.	String
MaximumScore	Resultado do cálculo de similaridade com informações do score	List
SimilarDevices	Lista de devices similares ao dispositivo e dados da transação.	List