Skip to content

Obtener configuración de webhook específico

GET
/webhook/{webhookid}

Obtiene los detalles de una configuración de webhook específica por su ID.

Información incluida:

  • Configuración completa del webhook
  • Estadísticas de entregas exitosas y fallidas
  • Tasa de éxito y tiempo promedio de respuesta
  • Últimas 10 entregas con sus estados
  • Eventos configurados y métricas por tipo

Authorizations

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters

Path Parameters

webhookid*

ID único del webhook

Typestring
Required
Example550e8400-e29b-41d4-a716-446655440000
formatuuid

Responses

Configuración del webhook obtenida exitosamente
application/json
JSON
{
"success": true,
"message": "Webhook configuration retrieved successfully",
"data": {
"webhook": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"tag": "payment_notifications",
"url": "https://erp.miempresa.com/api/webhooks/payments",
"request_header": {
"Content-Type": "application/json"
},
"request_body": "{"source":"kuenta"}",
"auth_enabled": true,
"auth_url": "https://auth.mi-api.com/oauth/token",
"auth_method": "POST",
"token_type": "Bearer",
"token_source_key": "access_token",
"token_header": true,
"entity_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2024-01-16T14:20:00Z",
"updated_at": "2024-01-20T14:15:00Z"
},
"name": "Webhook Pagos ERP",
"events": [
"order.approved",
"order.rejected",
"disbursement.approved"
],
"active": true,
"statistics": {
"total_requests": 150,
"successful_requests": 145,
"failed_requests": 5,
"success_rate": 96.67,
"last_successful": "2024-01-16T12:30:00Z",
"last_failed": "2024-01-15T08:15:00Z"
},
"event_statistics": [
{
"event_type": "order.approved",
"deliveries": 523,
"success_rate": 96.75
},
{
"event_type": "order.rejected",
"deliveries": 89,
"success_rate": 94.38
}
],
"recent_deliveries": [
{
"delivery_id": "123e4567-e89b-12d3-a456-426614174000",
"event_type": "order.approved",
"timestamp": "2024-01-25T09:45:00Z",
"status": "delivered",
"response_time": 234,
"response_code": 200,
"attempts": 1
}
]
}
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI