Skip to navigation

Create Headout Webhook Configuration

🆕 Create New Headout Webhook Configuration

Create a new webhook configuration with Headout API for receiving booking status updates.

📋 Request Body

{
"url": "https://your-domain.com/webhooks/headout/booking-status",
"enabled": true
}

⚠️ Requirements

  • HTTPS Only: Webhook URL must use HTTPS protocol (Headout requirement)
  • URL Length: Must be between 1 and 2048 characters
  • Valid Format: Must be a properly formatted URL
  • API Key: HEADOUT_API_KEY must be configured in environment

🎯 Use Cases

  • Initial Setup: Create webhook for the first time
  • New Environment: Set up webhook for a new deployment environment
  • Custom URLs: Configure webhook with specific URL requirements

📊 Response Codes

  • 200: Webhook created successfully
  • 400: Invalid request (bad URL format, missing fields)
  • 409: Webhook configuration already exists
  • 500: Internal server error

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"1-2048 characters
HTTPS URL where webhooks will be delivered
enabledbooleanOptionalDefaults to true
Whether the webhook is active

Response

Webhook configuration created successfully

Errors

400
Bad Request Error
409
Conflict Error