Un Webhook es un endpoint HTTP utilizado para recibir notificaciones de eventos. Cuando ocurre un evento específico, el sistema envía activamente una petición HTTP a una URL predefinida (la URL del Webhook). Los Webhooks se utilizan comúnmente para notificar a sistemas externos sobre cambios de estado o resultados de tareas asíncronas.
La depuración de Webhook simula un desencadenador de evento para verificar si el servicio externo recibe correctamente la petición.Para depurar un Webhook:
1.
Introduzca la URL de su Webhook en el campo URL de depuración
2.
Haga clic en "Send" para simular una llamada de Webhook
La documentación de Webhook incluye detalles como el nombre del Webhook, el método de petición y el cuerpo de la petición. Esto facilita que los usuarios comprendan qué tipo de datos se enviarán cuando ocurra un evento determinado.
Privacidad de la URL de depuración
La URL de depuraciónno se incluirá en la documentación ni en la exportación de OpenAPI; es solo para pruebas internas.
En el archivo OpenAPI exportado, los endpoints de Webhook se enumeran en el campo webhooks, que es diferente del campo paths de los endpoints regulares.
¿Por qué definir los Webhooks por separado en la documentación?
Según la especificación OpenAPI 3.1:
Los endpoints regulares se definen en el campo paths
Los endpoints de Webhook se definen en el campo webhooks
Esta separación clara garantiza que:
Los endpoints regulares sean llamados por clientes externos para realizar acciones o recuperar datos
Los Webhooks sean activados por el sistema para notificar a servicios externos
En Apidog, los Webhooks se tratan como un tipo de endpoint distinto para reflejar con precisión esta diferencia direccional y garantizar el formato correcto en las exportaciones de OpenAPI.Ejemplo:
/orders es un endpoint regular utilizado por los clientes
orderPaid es un Webhook activado por el sistema cuando un pedido se paga correctamente
¿Un Webhook es simplemente un endpoint regular?
¿La URL de depuración aparecerá en mi documentación de API?
