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:

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

Tipos de Validação

Abaixo constam os tipos retornados para o campo TypeId

Type IdDescrição
1Token Sms
2Token Email
42FA Sms
82FA Email
4096Biometrics
163842FA Whatsapp
32768Insight (pack)
65536Rating (pack)
131072Score (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 as execuções tiverem sido concluídas (no caso do pack assíncrono) e/ou 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.