> ## Documentation Index
> Fetch the complete documentation index at: https://documentacao.legitimuz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cadastrar webhooks

> Cadastre o endpoint que recebe a decisão da verificação e acompanhe cada entrega pelo dashboard.

Um webhook é um endpoint seu que a Legitimuz chama quando algo acontece numa verificação. Sem ele,
o seu sistema só sabe do resultado se perguntar. É por aqui que a decisão chega ao seu produto.

Os endpoints ficam em **Integrações → Segurança → Webhooks**, dentro da integração.

<Frame caption="Integrações → Segurança → Webhooks">
  <img src="https://mintcdn.com/legitimuz/8oB1wNy9hCpFq4Z0/images/platform/webhooks-vazio.jpg?fit=max&auto=format&n=8oB1wNy9hCpFq4Z0&q=85&s=3d69b3ce712f0ce1c19f4a93c2c453f6" alt="Aba Webhooks do dashboard sem endpoints cadastrados, com o botão Novo Endpoint" width="1456" height="840" data-path="images/platform/webhooks-vazio.jpg" />
</Frame>

## Cadastrar um endpoint

<Steps>
  <Step title="Clique em Novo Endpoint" />

  <Step title="Informe a URL e escolha os eventos">
    <Frame>
      <img src="https://mintcdn.com/legitimuz/8oB1wNy9hCpFq4Z0/images/platform/webhook-novo-endpoint.jpg?fit=max&auto=format&n=8oB1wNy9hCpFq4Z0&q=85&s=cc1de756cdfd3f4bcd687aaba4b71c89" alt="Diálogo Novo Endpoint com o campo URL do endpoint e a lista de eventos disponíveis com caixas de seleção" width="1456" height="840" data-path="images/platform/webhook-novo-endpoint.jpg" />
    </Frame>

    A URL precisa ser HTTPS e responder de fora da sua rede. Marque os eventos que você quer
    receber. Para começar, **Verificação decidida** é o único que a maioria precisa.
  </Step>

  <Step title="Guarde o segredo">
    O segredo de assinatura aparece na criação e é com ele que o seu servidor confere cada
    entrega. Guarde-o no cofre de segredos do seu backend.

    <Warning>
      O segredo não é exibido de novo e não aparece no histórico de entregas. Se você o perder,
      rotacione.
    </Warning>
  </Step>

  <Step title="Dispare uma entrega de teste">
    O dashboard envia um corpo de exemplo do evento que você escolher. Confirme que o seu servidor
    responde `2xx` e que a conferência da assinatura passa.
  </Step>
</Steps>

## Escopo do endpoint

| Escopo         | Recebe                                            |
| -------------- | ------------------------------------------------- |
| **Integração** | só os eventos das verificações daquela integração |
| **Conta**      | os eventos de todas as integrações                |

Endpoint por integração é o padrão sensato: o ambiente de homologação não dispara no endpoint de
produção, e um canal com problema não afeta o outro.

## Acompanhar as entregas

Cada entrega fica registrada com o evento, o resultado e o número da tentativa, na aba
**Webhooks** da integração e na aba **Webhooks** de cada
[verificação](/platform/verifications#webhooks).

| Tipo     | O que é                                           |
| -------- | ------------------------------------------------- |
| `event`  | disparada por algo que aconteceu numa verificação |
| `test`   | disparada por você, pelo botão de teste           |
| `replay` | reenvio manual de uma entrega anterior            |

Dali você reenvia o que falhou. A assinatura aparece redigida no histórico.

## Os eventos

| Evento                  | Quando dispara                                |
| ----------------------- | --------------------------------------------- |
| Verificação criada      | o seu backend criou a verificação             |
| Verificação iniciada    | a pessoa abriu o link e começou               |
| Documento enviado       | a pessoa enviou uma imagem de documento       |
| Documento processado    | a análise do documento terminou               |
| Prova de vida concluída | a prova de vida chegou a um desfecho          |
| Verificação decidida    | a verificação chegou ao desfecho final        |
| Score                   | o score de risco e de identidade ficou pronto |

## Para quem vai implementar

O contrato completo do lado do código está na tab **Webhooks**.

<Columns cols={3}>
  <Card title="Visão geral" icon="webhook" href="/webhooks/introduction">
    Por que usar, como funciona e boas práticas.
  </Card>

  <Card title="Eventos" icon="bolt" href="/webhooks/events">
    O corpo de cada um dos sete eventos.
  </Card>

  <Card title="Segurança" icon="shield-check" href="/webhooks/security">
    Conferir a assinatura em quatro linguagens.
  </Card>
</Columns>

## Próximo passo

<Card title="7. Verificações" icon="fingerprint" href="/platform/verifications" horizontal>
  Encontre, leia e decida uma verificação.
</Card>
