Skip to main content
POST

Overview

Creates a new webhook configuration for an agent. Webhooks allow you to receive real-time notifications when specific events occur during calls.

Endpoint

string
required
Agent UUID

Request

Response

boolean
Indicates if the webhook was created successfully
string
Success message
object
Created webhook object
string
Unique webhook identifier
string
Agent UUID this webhook belongs to
string
Webhook name
string
Webhook URL
array
Array of configured event types
integer
Request timeout in seconds
integer
Maximum retry attempts
boolean
Whether webhook is active
string
ISO 8601 timestamp when webhook was created
string
ISO 8601 timestamp when webhook was last updated
integer
Number of events configured for this webhook
string
Current webhook status

Error responses

Validation rules

  • name: Required, string, maximum 255 characters
  • webhook_url: Required, valid URL, maximum 500 characters
  • webhook_secret: Optional, string, maximum 255 characters
  • events: Required, array with minimum 1 event, each event must be from available events list
  • timeout: Optional, integer between 5-120 seconds (default: 30)
  • max_retries: Optional, integer between 0-10 (default: 3)
  • enabled: Optional, boolean (default: true)

Important notes

  • Webhook operations automatically clear the agent cache for immediate effect
  • Use HTTPS endpoints for webhook URLs in production
  • Implement proper signature verification using the webhook secret for security
  • Test your webhook endpoint before going live using the test endpoint