<!-- https://www.akrus.digital/docs/webhooks · revisado em 2026-10-08 · gerado do mesmo conteúdo da página HTML -->
_Ferramentas e versões · v1 em prévia_

# Planeje eventos sem presumir uma assinatura ativa.

Webhooks notificam outro sistema quando algo acontece. Sua disponibilidade precisa ser confirmada antes de usar esse caminho.

> **Sem assinatura de eventos publicada**
>
> O contrato público v1 documentado aqui é de leitura. Não há nesta documentação um contrato liberado de assinatura de eventos para aplicações de terceiros.
>
> [Ver disponibilidade](https://www.akrus.digital/docs/ambientes)

## O que precisa ser definido

### Contrato dos eventos

- [ ] Catálogo e versão dos eventos.
- [ ] Formato do payload e identificador de evento.

### Entrega e segurança

- [ ] Assinatura, validação e rotação de segredos.
- [ ] Política de novas tentativas, duplicatas, ordem e reenvio.
- [ ] Ambiente de teste e forma de cadastrar o destino.

## O que pode ser usado agora no planejamento

Consulte o contrato de leitura e seus limites. Os endpoints que recebem notificações de provedores de pagamento são infraestrutura da Akrus e não são uma API de inscrição para integradores.

- [Referência da API](https://www.akrus.digital/docs/api)
- [Paginação](https://www.akrus.digital/docs/paginacao)

## Prepare o sistema receptor sem inventar eventos

Defina como sua aplicação guardaria identificadores para evitar processamento duplicado, como registraria falhas e como conciliaria o estado atual após uma interrupção. Essas são necessidades do seu projeto; nomes de eventos, cabeçalhos e regras de assinatura só devem ser implementados após a publicação do contrato.

> **Alternativa para avaliar com a equipe**
>
> Quando o acesso à API de leitura estiver autorizado, consultas periódicas podem apoiar a conferência de registros. Respeite os limites e mantenha reconciliação de estados antigos. Paginar apenas itens novos não detecta todas as alterações posteriores.

## Dúvidas frequentes

### Posso usar os webhooks de pagamento da Akrus como assinatura de eventos?

Não. Receber notificações de um provedor é uma função interna da plataforma e não oferece uma inscrição pública para sistemas de terceiros.

## Descreva a necessidade de eventos

Informe o evento esperado, o sistema de destino e o tempo de atualização necessário.

[Conversar sobre integração](https://www.akrus.digital/contato?assunto=api)

---

Anterior: [Homologação](https://www.akrus.digital/docs/homologacao) · Próximo: [SDKs e exemplos](https://www.akrus.digital/docs/sdks)
