Notificação via Webhook

Cadastro de Url

Sempre que ocorrer uma alteração de uma transação, o Webhook da Clearsale irá enviar uma notificação para uma URL que deverá ser implementada no lado do integrador.

Para cadastrar as URLs é necessário contatar o [email protected] informando os dados da tabela abaixo:

Dado	Descrição
Nome Cliente	Nome Fantasia do cliente que contratou a Plataforma Data Trust
URL	URL que será chamada quando houver uma alteração na transação (a mesma URL poderá se repetir entre os tipos de alteração)
Token	O token informado deverá ser uma chave secreta que será enviado nas chamadas de Webhook no Header "Authorization: Bearer {Token}"
Tipo	Ver tabela abaixo Tipos de Validação (Type Id)

Tipos de Validação

Abaixo constam os tipos retornados para o campo TypeId

Type Id	Descrição
1	Token Sms
2	Token Email
4	2FA Sms
8	2FA Email
16	Pack
4096	Biometrics
16384	2FA Whatsapp
32768	Insight (pack)
65536	Rating (pack)
131072	Score (pack)

Chamada de retorno

Os demais dados da alteração não serão informados na notificação do Webhook, portanto, fica a cargo do integrador o consumo da consulta.

Requisição

Json 
POST {URL_CADASTRADA} 
Authorization: Bearer {TOKEN_CADASTRADO} 
Content-Type: application/json; charset=utf-8  
{ 
 "Code": "{CODIGO_DA_SUA_TRANSAÇÃO}", 
 "TypeId": 2, 
 "IdentifierId" : "{SEU_IDENTIFIER_ID}", 
 "Description": "{DESCRIÇÃO_DA_ALTERAÇÃO}", 
 "Date": "2020-12-28T12:45:00.000", 
 "PackIdentifier": "{Nome do Pack}" 
}

Os módulos Score, Rating, Insights só gerarão notificações se estiverem dentro de um Pack, não existem notificações para eles no fluxo modularizado. Eles irão gerar notificações quando forem atualizados a partir de alguma interação com outro módulo. Por exemplo, se você tem um Pack que inclui o Score e o 2FA SMS e houve uma resposta a um 2FA SMS, o Webhook notificará tanto o 2FA SMS quanto o Score caso haja atualizações.