> For the complete documentation index, see [llms.txt](https://docs.compliance.phalcon.blocksec.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.compliance.phalcon.blocksec.com/pt-br/manual/notification-channels/webhook-format.md).

# Formato Webhook

## Mensagem de Webhook

<table><thead><tr><th width="192.21875">Campo</th><th width="125.03125">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>type</td><td>Integer</td><td><p>Tipo de mensagem recebida pelo Webhook:</p><ol><li>notification (alerta do Risk Engine)</li><li>monitorEvent (evento de Monitor)</li></ol></td></tr><tr><td>typeDescription</td><td>String</td><td><p>O intervalo de valores válidos da variável:</p><p>["notification", "monitorEvent"]</p></td></tr><tr><td>data</td><td>Object</td><td>Os detalhes específicos da mensagem são determinados pelo valor de type.</td></tr></tbody></table>

### Dados de Notificação

<table><thead><tr><th width="198.01953125">Campo</th><th width="133.109375">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>triggeringId</td><td>String</td><td>O ID do alerta que disparou a notificação.</td></tr><tr><td>riskEngineId</td><td>String</td><td>O ID do risk engine que disparou a notificação.</td></tr><tr><td>riskEngineName</td><td>String</td><td>O nome do risk engine que disparou a notificação.</td></tr><tr><td>targetType</td><td>Integer</td><td><p>1: address</p><p>2: transaction</p></td></tr><tr><td>targetTypeDescription</td><td>String</td><td><p>O intervalo de valores válidos da variável:</p><p>["address", "transaction"]</p></td></tr><tr><td>chainId</td><td>Integer</td><td>O ID da chain para diferentes redes blockchain.</td></tr><tr><td>targetIdentifiter</td><td>String</td><td><p>Se targetType é 1, é um address</p><p>Se targetType é 2, é um hash de transação</p></td></tr><tr><td>riskType</td><td>Integer</td><td><p>O tipo de risco associado ao risk engine que disparou a notificação.</p><p>1: exposure</p><p>2: behavior</p></td></tr><tr><td>riskTypeDescription</td><td>String</td><td><p>O intervalo de valores válidos da variável:</p><p>["exposure", "behavior"]</p></td></tr><tr><td>riskLevel</td><td>Integer</td><td><p>O nível de risco definido pelo usuário associado ao risk engine que disparou a notificação.</p><ol><li>critical</li><li>high</li><li>medium</li><li>low</li><li>informational</li></ol></td></tr><tr><td>riskLevelDescription</td><td>String</td><td><p>O intervalo de valores válidos da variável:</p><p>["critical", "high", "medium", "low", "informational"]</p></td></tr><tr><td>timestamp</td><td>String</td><td>O timestamp do alerta, em formato ISO 8601.</td></tr><tr><td>type</td><td>Integer</td><td><p>Tipo de dados de notificação detalhada</p><p>Tipo de address:</p><p>1: Dados de Entity Risk</p><p>2: Dados de Interaction Risk</p><p>3: Dados de Large Transfer</p><p>4: Dados de High-Frequency</p><p>5: Dados de Transit Address</p><p>6: Dados de Blocklist Interaction</p><p>Tipo de transaction:</p><p>7: Dados de Participant Risk</p><p>8: Dados de Interaction Risk</p><p>9: Dados de Large Transfer</p><p>10: Dados de Rapid Transit</p><p>11: Dados de Blocklist Interaction</p></td></tr><tr><td>data</td><td>Array[Object]</td><td><p>A lista de informações detalhadas para a notificação é determinada pelo tipo de risk engine.</p><p>Para mais detalhes, consulte as seções a seguir.</p></td></tr></tbody></table>

#### 1. Address - Dados de Entity Risk

<table><thead><tr><th width="203.15234375">Campo</th><th width="133.04296875">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>riskIndicator</td><td>Integer</td><td><p>O indicador de risco que corresponde com base nas regras pré-configuradas.</p><p>1: Sanctioned</p><p>2: Attack</p><p>3: Scam</p><p>4: Ransomware</p><p>5: Child Abuse Material</p><p>6: Laundering</p><p>7: Mixing</p><p>8: Dark Market</p><p>9: Darkweb Business</p><p>10: Blocked</p><p>11: Gambling</p><p>12: No KYC Exchange<br>13. Terrorist Financing<br>14. FATF High Risk Jurisdiction<br>15. FATF Grey List Jurisdiction<br>16. Human Trafficking<br>17. Drug Trafficking</p></td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td><p>O intervalo de valores válidos da variável:</p><p>["Sanctioned", "Attack", "Scam", "Ransomware", "Child Abuse Material", "Laundering", "Mixing", "Dark Market", "Darkweb Business", "Blocked", "Gambling", "No KYC Exchange", "Terrorist Financing", "FATF High Risk Jurisdiction", "FATF Grey List Jurisdiction", "Human Trafficking", "Drug Trafficking"]</p></td></tr><tr><td>detail</td><td>Array[String]</td><td>Informações complementares</td></tr></tbody></table>

#### 2. Address - Dados de Interaction Risk

<table><thead><tr><th width="213.07421875">Campo</th><th width="133.50390625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>riskIndicator</td><td>Integer</td><td>Utiliza os mesmos valores e definições que ***Dados de Entity Risk***</td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td>Utiliza os mesmos valores e definições que ***Dados de Entity Risk***</td></tr><tr><td>direction</td><td>Integer</td><td>Direção da transferência:<br>• 1 : In (fundos recebidos)<br>• 2 : Out (fundos enviados)</td></tr><tr><td>hop</td><td>Integer</td><td>Grau de separação da entidade em risco:<br>• 1 : Interação direta<br>• 2+ : Interação indireta (contagem de hops)</td></tr><tr><td>exposureValue</td><td>String</td><td>O valor absoluto dos fundos expostos (em USD)</td></tr><tr><td>exposurePercent</td><td>String</td><td>A percentagem do volume total de transações considerada "contaminada" pelo risco</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>Detalhes desta interação, incluindo uma lista de cada address contribuinte e suas informações específicas de exposição ao risco nesta interação.</td></tr><tr><td>>address</td><td>String</td><td>O address com o indicador de risco.</td></tr><tr><td>>label</td><td>String</td><td>O rótulo do address.</td></tr><tr><td>>detail</td><td>String</td><td>Informações de risco detalhadas.</td></tr><tr><td>>hop</td><td>Integer</td><td>A contagem mínima de hops para o address verificado.</td></tr><tr><td>>exposureValue</td><td>String</td><td>O valor de exposição ao risco contribuído, em USD.</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>A percentagem de exposição ao risco contribuída.</td></tr></tbody></table>

#### 3. Address - Dados de Large Transfer

<table><thead><tr><th width="205.31640625">Campo</th><th width="97.8984375">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>transaction</td><td>String</td><td>Hash da transação</td></tr><tr><td>usdValue</td><td>String</td><td>Valor da transferência, em USD</td></tr><tr><td>direction</td><td>Integer</td><td>Direção da transferência:<br>• 1 : In (fundos recebidos)<br>• 2 : Out (fundos enviados)</td></tr><tr><td>timestamp</td><td>String</td><td>O timestamp da transação, em formato ISO 8601</td></tr><tr><td>token</td><td>String</td><td>Endereço do contrato do token</td></tr><tr><td>tokenSymbol</td><td>String</td><td>Símbolo do token</td></tr><tr><td>tokenAmount</td><td>String</td><td>Quantidade de tokens</td></tr></tbody></table>

#### 4. Address - Dados de High-Frequency

<table><thead><tr><th width="201.19140625">Campo</th><th width="142.28515625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>transactionCount</td><td>Integer</td><td>O número total de transações dentro do período de observação</td></tr><tr><td>duration</td><td>Integer</td><td>Arredondado para o minuto mais próximo</td></tr><tr><td>transactionList</td><td>Array[Object]</td><td>Um array de detalhes de transações individuais</td></tr><tr><td>>transactionItem</td><td>Object</td><td>Formato do item de transação: mesmo que o esquema de **Dados de Large Transfer**</td></tr></tbody></table>

#### 5. Address - Dados de Transit Address

<table><thead><tr><th width="179.84765625">Campo</th><th width="118.41796875">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>inTransaction</td><td>String</td><td>Hash da transação de entrada</td></tr><tr><td>inTimestamp</td><td>String</td><td>Timestamp da transação de entrada, em formato ISO 8601</td></tr><tr><td>inUsdValue</td><td>String</td><td>Valor da transferência de entrada (USD)</td></tr><tr><td>outTransaction</td><td>String</td><td>Hash da transação de saída</td></tr><tr><td>outTimestamp</td><td>String</td><td>Timestamp da transação de saída, em formato ISO 8601</td></tr><tr><td>outUsdValue</td><td>String</td><td>Valor da transferência de saída (USD)</td></tr><tr><td>transitPercent</td><td>String</td><td>Percentagem de fundos em trânsito</td></tr></tbody></table>

#### 6. Address - Dados de Blocklist Interaction

<table><thead><tr><th width="213.07421875">Campo</th><th width="133.50390625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>direction</td><td>Integer</td><td>Direção da transferência:<br>• 1 : In (fundos recebidos)<br>• 2 : Out (fundos enviados)</td></tr><tr><td>hop</td><td>Integer</td><td>Grau de separação da entidade em risco:<br>• 1 : Interação direta<br>• 2+ : Interação indireta (contagem de hops)</td></tr><tr><td>exposureValue</td><td>String</td><td>O valor absoluto dos fundos expostos (em USD)</td></tr><tr><td>exposurePercent</td><td>String</td><td>A percentagem do volume total de transações considerada "contaminada" pelo risco</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>Detalhes desta interação, incluindo uma lista de cada address contribuinte e suas informações específicas de exposição ao risco nesta interação.</td></tr><tr><td>>address</td><td>String</td><td>O address com o indicador de risco.</td></tr><tr><td>>label</td><td>String</td><td>O rótulo do address.</td></tr><tr><td>>hop</td><td>Integer</td><td>A contagem mínima de hops para o address verificado.</td></tr><tr><td>>exposureValue</td><td>String</td><td>O valor de exposição ao risco contribuído, em USD.</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>A percentagem de exposição ao risco contribuída.</td></tr></tbody></table>

#### 7. Transaction - Dados de Participant Risk

<table><thead><tr><th width="158.515625">Campo</th><th width="143.9140625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>address</td><td>String</td><td>O address do participante onde o indicador de risco foi detectado.</td></tr><tr><td>riskIndicator</td><td>Integer</td><td>Utiliza os mesmos valores e definições que ***Dados de Entity Risk***</td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td>Utiliza os mesmos valores e definições que ***Dados de Entity Risk***</td></tr><tr><td>detail</td><td>Array[String]</td><td>Informações complementares</td></tr></tbody></table>

#### 8. Transaction - Dados de Interaction Risk

<table><thead><tr><th width="213.07421875">Campo</th><th width="133.50390625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>riskIndicator</td><td>Integer</td><td>Utiliza os mesmos valores e definições que ***Dados de Entity Risk***</td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td>Utiliza os mesmos valores e definições que ***Dados de Entity Risk***</td></tr><tr><td>direction</td><td>Integer</td><td>Direção da transferência:<br>• 1 : In (fundos recebidos)<br>• 2 : Out (fundos enviados)</td></tr><tr><td>hop</td><td>Integer</td><td>Grau de separação da entidade em risco:<br>• 1 : Interação direta<br>• 2+ : Interação indireta (contagem de hops)</td></tr><tr><td>exposureValue</td><td>String</td><td>O valor absoluto dos fundos expostos (em USD)</td></tr><tr><td>exposurePercent</td><td>String</td><td>A percentagem do volume total de transações considerada "contaminada" pelo risco</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>Detalhes desta interação, incluindo uma lista de cada address contribuinte e suas informações específicas de exposição ao risco nesta interação.</td></tr><tr><td>>address</td><td>String</td><td>O address com o indicador de risco.</td></tr><tr><td>>label</td><td>String</td><td>O rótulo do address.</td></tr><tr><td>>detail</td><td>String</td><td>Informações de risco detalhadas.</td></tr><tr><td>>hop</td><td>Integer</td><td>A contagem mínima de hops para o address verificado.</td></tr><tr><td>>exposureValue</td><td>String</td><td>O valor de exposição ao risco contribuído, em USD.</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>A percentagem de exposição ao risco contribuída.</td></tr></tbody></table>

#### 9. Transaction - Dados de Large Transfer

<table><thead><tr><th width="224.0390625">Campo</th><th width="202.22265625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>transaction</td><td>String</td><td>Hash da transação</td></tr><tr><td>usdValue</td><td>String</td><td>Valor da transferência, em USD</td></tr><tr><td>fromAddress</td><td>String</td><td>Endereço do remetente</td></tr><tr><td>toAddress</td><td>String</td><td>Endereço do destinatário</td></tr><tr><td>timestamp</td><td>String</td><td>O timestamp da transação, em formato ISO 8601</td></tr><tr><td>token</td><td>String</td><td>Endereço do contrato do token</td></tr><tr><td>tokenSymbol</td><td>String</td><td>Símbolo do token</td></tr><tr><td>tokenAmount</td><td>String</td><td>Quantidade de tokens nesta transferência</td></tr></tbody></table>

#### 10. Transaction - Dados de Rapid Transit

<table><thead><tr><th width="223.77734375">Campo</th><th width="201">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>proceedTransaction</td><td>Object</td><td>Formato do objeto: mesmo que o esquema de Dados de Large Transfer</td></tr><tr><td>ScreenedTransaction</td><td>Object</td><td>Formato do objeto: mesmo que o esquema de Dados de Large Transfer</td></tr></tbody></table>

#### 11. Transaction - Dados de Blocklist Interaction

<table><thead><tr><th width="213.07421875">Campo</th><th width="133.50390625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>direction</td><td>Integer</td><td>Direção da transferência:<br>• 1 : In (fundos recebidos)<br>• 2 : Out (fundos enviados)</td></tr><tr><td>hop</td><td>Integer</td><td>Grau de separação da entidade em risco:<br>• 1 : Interação direta<br>• 2+ : Interação indireta (contagem de hops)</td></tr><tr><td>exposureValue</td><td>String</td><td>O valor absoluto dos fundos expostos (em USD)</td></tr><tr><td>exposurePercent</td><td>String</td><td>A percentagem do volume total de transações considerada "contaminada" pelo risco</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>Detalhes desta interação, incluindo uma lista de cada address contribuinte e suas informações específicas de exposição ao risco nesta interação.</td></tr><tr><td>>address</td><td>String</td><td>O address com o indicador de risco.</td></tr><tr><td>>label</td><td>String</td><td>O rótulo do address.</td></tr><tr><td>>hop</td><td>Integer</td><td>A contagem mínima de hops para o address verificado.</td></tr><tr><td>>exposureValue</td><td>String</td><td>O valor de exposição ao risco contribuído, em USD.</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>A percentagem de exposição ao risco contribuída.</td></tr></tbody></table>

***

## Dados de Evento de Monitor

Quando um canal de notificação tem **Monitor Events** habilitado, os eventos de Monitor são entregues como mensagens `type: 2` (`monitorEvent`). Apenas eventos relacionados a risco são enviados (não eventos de ciclo de vida como monitoramento iniciado/parado). A entrega é controlada pelas suas [configurações de acionamento de notificações](/pt-br/manual/monitor.md#setting-up-notifications).

### Campos Comuns

Todas as mensagens de evento de Monitor compartilham esses campos no objeto `data`:

<table><thead><tr><th width="210">Campo</th><th width="110">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>eventType</td><td>Integer</td><td>Tipo de evento: 4 (risk_level_increased), 5 (risk_level_decreased), 6 (alert_triggered), 7 (alert_expired)</td></tr><tr><td>eventTypeDescription</td><td>String</td><td>Nome do tipo de evento legível para humanos</td></tr><tr><td>targetType</td><td>Integer</td><td>1: address, 2: transaction (atualmente apenas address é suportado)</td></tr><tr><td>targetTypeDescription</td><td>String</td><td>"address" ou "transaction"</td></tr><tr><td>chainId</td><td>Integer</td><td>ID da chain</td></tr><tr><td>targetIdentifier</td><td>String</td><td>O address monitorado</td></tr><tr><td>riskLevel</td><td>Integer</td><td>Nível de risco geral atual do address (1: critical, 2: high, 3: medium, 4: low)</td></tr><tr><td>riskLevelDescription</td><td>String</td><td>Nome do nível de risco</td></tr><tr><td>timestamp</td><td>String</td><td>Tempo do evento em formato ISO 8601</td></tr></tbody></table>

### Nível de Risco Aumentado / Diminuído (eventType 4, 5)

Enviado quando o nível de risco geral de um address monitorado muda. Inclui esses campos adicionais:

<table><thead><tr><th width="210">Campo</th><th width="110">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>prevLevel</td><td>Integer</td><td>Nível de risco antes da mudança</td></tr><tr><td>prevLevelDescription</td><td>String</td><td>Nome do nível de risco anterior</td></tr><tr><td>newLevel</td><td>Integer</td><td>Nível de risco após a mudança</td></tr><tr><td>newLevelDescription</td><td>String</td><td>Nome do novo nível de risco</td></tr><tr><td>relatedAlerts</td><td>Array</td><td>Alertas que causaram a mudança de nível</td></tr></tbody></table>

Cada objeto em `relatedAlerts`:

<table><thead><tr><th width="210">Campo</th><th width="110">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>alertId</td><td>String</td><td>ID do alerta</td></tr><tr><td>riskEngineId</td><td>String</td><td>ID do Risk Engine</td></tr><tr><td>riskEngineName</td><td>String</td><td>Nome do Risk Engine</td></tr><tr><td>riskLevel</td><td>Integer</td><td>Nível de risco do alerta</td></tr><tr><td>riskLevelDescription</td><td>String</td><td>Nome do nível de risco do alerta</td></tr><tr><td>action</td><td>String</td><td>"triggered" ou "expired"</td></tr></tbody></table>

### Alerta Acionado / Expirado (eventType 6, 7)

Enviado quando alertas são acionados ou expiram sem causar uma mudança no nível de risco. Se causarem uma mudança de nível, eles são incluídos em `relatedAlerts` da mensagem de Nível de Risco Aumentado/Diminuído.

Esses eventos incluem um array `alerts` com os seguintes campos por objeto:

<table><thead><tr><th width="230">Campo</th><th width="110">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>alertId</td><td>String</td><td>ID do alerta</td></tr><tr><td>riskEngineId</td><td>String</td><td>ID do Risk Engine</td></tr><tr><td>riskEngineName</td><td>String</td><td>Nome do Risk Engine</td></tr><tr><td>alertRiskLevel</td><td>Integer</td><td>O nível de risco próprio do alerta (distinto do nível de risco geral do address)</td></tr><tr><td>alertRiskLevelDescription</td><td>String</td><td>Nome do nível de risco do alerta</td></tr><tr><td>description</td><td>String</td><td>Descrição do alerta</td></tr></tbody></table>