Skip to navigation

Get Comprehensive Webhook Status

📊 Get Comprehensive Webhook Status and Health

Retrieve detailed information about webhook configuration, endpoint health, and system status.

📋 Response Format

{
"success": true,
"message": "Webhook status retrieved successfully",
"data": {
"configured": true,
"configuration": {
"url": "https://api.etera.dev/experience/booking/webhooks/headout/booking-status",
"enabled": true
},
"endpointHealth": {
"accessible": true,
"error": null
},
"environment": "production",
"apiKeyConfigured": true
},
"timestamp": "2024-01-15T10:30:00.000Z"
}

🔍 Status Information

Configuration Status

  • configured: Whether webhook is configured with Headout
  • configuration: Current webhook settings (URL, enabled status)

Health Status

  • endpointHealth: Webhook endpoint accessibility test results
  • accessible: Whether the endpoint responds to requests
  • error: Any connectivity errors encountered

System Status

  • environment: Current deployment environment
  • apiKeyConfigured: Whether HEADOUT_API_KEY is configured

🎯 Use Cases

  • Health Dashboard: Monitor webhook system health
  • Troubleshooting: Diagnose webhook delivery issues
  • Monitoring: Check webhook configuration and connectivity
  • Alerts: Detect webhook configuration problems

📊 Response Codes

  • 200: Status retrieved successfully
  • 500: Internal server error

Authentication

AuthorizationBearer

JWT token from @etera-ai/auth package (auth.etera.dev) - Format: Bearer <token>

Response

Webhook status retrieved successfully