Um Webhook é um endpoint HTTP utilizado para receber notificações de eventos. Quando ocorre um evento específico, o sistema envia ativamente um pedido HTTP para um URL predefinido (o URL do Webhook). Os Webhooks são normalmente utilizados para notificar sistemas externos sobre alterações de estado ou resultados de tarefas assíncronas.
A documentaç ão de Webhooks inclui detalhes como o nome do Webhook, o método do pedido e o corpo do pedido. Isto facilita aos utilizadores compreender que tipo de dados será enviado quando ocorrer um determinado evento.
Privacidade do URL de Depuração
O URL de Depuraçãonão será incluído na documentação nem na exportação OpenAPI — é apenas para testes internos.
No ficheiro OpenAPI exportado, os endpoints de Webhook são listados no campo webhooks, que é diferente do campo paths dos endpoints normais.
Por que razão definir Webhooks separadamente na documentação?
De acordo com a especificação OpenAPI 3.1:
Os endpoints normais são definidos no campo paths
Os endpoints de Webhook são definidos no campo webhooks
Esta separação clara garante que:
Os endpoints normais são chamados por clientes externos para executar ações ou obter dados
Os Webhooks são acionados pelo sistema para notificar serviços externos
No Apidog, os Webhooks são tratados como um tipo de endpoint distinto para refletir com precisão esta diferença direcional e garantir a formatação correta nas exportações OpenAPI.Exemplo:
/orders é um endpoint normal utilizado por clientes
orderPaid é um Webhook acionado pelo sistema quando uma encomenda é paga com sucesso
Um Webhook é apenas um endpoint normal?
O URL de Depuração aparecerá na minha documentação da API?
