> ## Documentation Index
> Fetch the complete documentation index at: https://nexus-docs.ticto.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks / retornos assíncronos

> Seus sistemas sincronizados em tempo real.

A API Nexus possui um módulo avançado de **Client Settings** que permite o envio de callbacks para manter seus sistemas sincronizados em tempo real.

## Configuração do webhook

Você pode definir seu endpoint receptor chamando `POST /api/v1/client-settings` com o body:

```json theme={null}
{
  "webhook_endpoint": "https://sua-api.com.br/webhooks/ticto",
  "events": [
    "user_updated",
    "user_onboarded",
    "bank_account_updated",
    "product_updated",
    "offer_updated"
  ],
  "active": 1
}
```

## Recepção de callbacks

Sempre que um dos eventos mapeados ocorrer, nosso serviço disparará um `POST` contendo o respectivo payload atualizado da entidade em seu `webhook_endpoint`.

<Warning>
  **IPs em whitelist:** para evitar bloqueios pelo seu WAF ou Firewall, certifique-se de liberar o bloco de IPs dos servidores de notificação da Ticto. Consulte o time de suporte/DevOps para obter a listagem exata de IPs de Produção vigentes.
</Warning>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.