Skip to navigation

Setup Headout Webhook Configuration

🚀 Setup Headout Webhook Configuration

Automatically configure webhook with Headout API for booking status updates.

🔧 What This Does

Automatic Configuration

  • Environment Detection: Determines correct webhook URL based on environment
  • Create or Update: Creates new webhook or updates existing configuration
  • URL Validation: Ensures webhook URL uses HTTPS as required by Headout

Webhook URL Structure

  • Production: https://api.etera.dev/experience/booking/webhooks/headout/booking-status
  • Staging: https://api-staging.etera.dev/experience/booking/webhooks/headout/booking-status
  • Development: https://api-dev.etera.dev/experience/booking/webhooks/headout/booking-status

🎯 Use Cases

  • Initial Setup: Configure webhook for the first time
  • Environment Migration: Update webhook URL when deploying to new environment
  • Configuration Recovery: Re-establish webhook after configuration loss
  • URL Updates: Update webhook URL after domain or path changes

⚠️ Requirements

  • HEADOUT_API_KEY: Must be configured in environment variables
  • HTTPS URL: Webhook URL must use HTTPS protocol (Headout requirement)
  • API Access: Valid Headout API key with webhook management permissions

📋 Response Information

  • Success: Whether webhook was configured successfully
  • Webhook URL: The configured webhook endpoint URL
  • Message: Detailed result message
  • Error: Error details if configuration failed

Authentication

AuthorizationBearer

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

Response

Webhook setup completed (check success field for actual result)