Skip to navigation

Get Current Headout Webhook Configuration

🔍 Retrieve Current Headout Webhook Configuration

Fetch the current webhook configuration from Headout API.

📋 Response Format

{
"success": true,
"message": "Webhook configuration retrieved successfully",
"data": {
"url": "https://your-domain.com/webhooks/headout/booking-status",
"enabled": true
},
"timestamp": "2024-01-15T10:30:00.000Z"
}

🎯 Use Cases

  • Configuration Check: Verify current webhook settings
  • Status Monitoring: Check if webhook is enabled/disabled
  • URL Verification: Confirm webhook endpoint URL
  • Debugging: Troubleshoot webhook delivery issues

📊 Response Scenarios

  • Configuration Exists: Returns webhook URL and enabled status
  • No Configuration: Returns success=true with data=undefined
  • API Error: Returns success=false with error details

📊 Response Codes

  • 200: Configuration retrieved successfully (or not found)
  • 401: Unauthorized - Invalid API key
  • 500: Internal server error

Authentication

AuthorizationBearer

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

Response

Webhook configuration retrieved successfully

Errors

404
Not Found Error