Endpoints relacionados à gestão de webhooks.
Um webhook é uma forma de receber notificações em tempo real de eventos que ocorrem em outro sistema. Ao registrar um webhook, você fornece uma URL de destino e, sempre que um evento ocorre (por exemplo, cadastro de um novo aluno ou atualização de contrato), o sistema envia uma requisição HTTP para essa URL com os dados do evento.
Isso permite que você automatize ações no seu sistema, como:
- Atualizar seu banco de dados automaticamente quando um novo contrato é criado
- Enviar notificações internas para colaboradores
- Integrar eventos do sistema a outras ferramentas ou dashboards
Exemplo de uso:
- Você cadastra um webhook apontando para
https://meusistema.com/webhooks/novo-contrato. - Quando um cliente faz um novo contrato, o sistema envia um POST para essa URL com os dados do contrato.
- Seu sistema processa o evento e, por exemplo, envia um email para o consultor responsável ou atualiza o dashboard de vendas.
Endpoints disponíveis
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/v1/webhook | Adiciona um novo webhook, registrando a URL que receberá os eventos do sistema. |
GET | /api/v1/webhook | Lista todos os webhooks cadastrados, permitindo acompanhar quais URLs estão ativas e quais eventos recebem. |
DELETE | /api/v1/webhook | Remove um webhook específico pelo seu ID, interrompendo o envio de eventos para essa URL. |