Skip to main content
GET
/
api
/
v1
/
agents
/
{agent_id}
/
webhooks
curl -X GET \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks' \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "data": {
    "webhooks": [
      {
        "id": "9fcafbf2-7593-44d6-8cd7-1b221beba62a",
        "agent_id": "9fbef0b7-8d4e-4a08-9207-66c22155721d",
        "name": "My Webhook",
        "webhook_url": "https://example.com/webhook",
        "events": ["event_phone_call_started", "event_phone_call_ended"],
        "timeout": 30,
        "max_retries": 3,
        "enabled": true,
        "created_at": "2025-09-03T23:19:51.000000Z",
        "updated_at": "2025-09-03T23:37:01.000000Z",
        "events_count": 2,
        "status": "active"
      }
    ],
    "available_events": {
      "event_phone_call_started": "Phone call has started",
      "event_phone_call_ended": "Phone call has ended",
      "event_phone_call_did_not_connect": "Phone call failed to connect",
      "event_phone_call_connected": "Phone call connection established",
      "event_phone_call_disconnected": "Phone call connection closed",
      "event_phone_call_error": "Phone call connection error occurred",
      "event_participant_joined": "Participant joined the call",
      "event_participant_left": "Participant left the call",
      "event_voicemail_detected": "Voicemail system detected",
      "event_voicemail_message_left": "Message left on voicemail",
      "event_conversation_started": "Human conversation started",
      "event_conversation_ended": "Human conversation ended",
      "event_action": "Agent executed an action",
      "event_action_failed": "Agent action failed",
      "event_recording": "Call recording event",
      "event_connection_established": "Call connection established",
      "event_connection_closed": "Call connection closed",
      "event_connection_error": "Call connection error occurred",
      "event_user_connected": "User connected to the call",
      "event_user_disconnected": "User disconnected from the call",
      "event_client_connected": "Client connected to the call",
      "event_client_disconnected": "Client disconnected from the call"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.talkover.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Lists all webhooks configured for a specific agent, including their current status, configured events, and metadata.

​
Endpoint

​
agent_id
string
required
Agent UUID

​
Request

curl -X GET \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks' \
  -H 'Authorization: Bearer YOUR_TOKEN'

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
Response data containing webhooks and available events
​
data.webhooks
array
Array of webhook configurations for the agent
​
data.webhooks[].id
string
Unique webhook identifier
​
data.webhooks[].agent_id
string
Agent UUID this webhook belongs to
​
data.webhooks[].name
string
Human-readable webhook name
​
data.webhooks[].webhook_url
string
URL where webhook events will be sent
​
data.webhooks[].events
array
Array of event types this webhook is configured to receive
​
data.webhooks[].timeout
integer
Request timeout in seconds (5-120)
​
data.webhooks[].max_retries
integer
Maximum number of retry attempts (0-10)
​
data.webhooks[].enabled
boolean
Whether the webhook is currently active
​
data.webhooks[].created_at
string
ISO 8601 timestamp when webhook was created
​
data.webhooks[].updated_at
string
ISO 8601 timestamp when webhook was last updated
​
data.webhooks[].events_count
integer
Number of events configured for this webhook
​
data.webhooks[].status
string
Current webhook status (active, disabled, error)
​
data.available_events
object
Object containing all available webhook events and their descriptions
{
  "success": true,
  "data": {
    "webhooks": [
      {
        "id": "9fcafbf2-7593-44d6-8cd7-1b221beba62a",
        "agent_id": "9fbef0b7-8d4e-4a08-9207-66c22155721d",
        "name": "My Webhook",
        "webhook_url": "https://example.com/webhook",
        "events": ["event_phone_call_started", "event_phone_call_ended"],
        "timeout": 30,
        "max_retries": 3,
        "enabled": true,
        "created_at": "2025-09-03T23:19:51.000000Z",
        "updated_at": "2025-09-03T23:37:01.000000Z",
        "events_count": 2,
        "status": "active"
      }
    ],
    "available_events": {
      "event_phone_call_started": "Phone call has started",
      "event_phone_call_ended": "Phone call has ended",
      "event_phone_call_did_not_connect": "Phone call failed to connect",
      "event_phone_call_connected": "Phone call connection established",
      "event_phone_call_disconnected": "Phone call connection closed",
      "event_phone_call_error": "Phone call connection error occurred",
      "event_participant_joined": "Participant joined the call",
      "event_participant_left": "Participant left the call",
      "event_voicemail_detected": "Voicemail system detected",
      "event_voicemail_message_left": "Message left on voicemail",
      "event_conversation_started": "Human conversation started",
      "event_conversation_ended": "Human conversation ended",
      "event_action": "Agent executed an action",
      "event_action_failed": "Agent action failed",
      "event_recording": "Call recording event",
      "event_connection_established": "Call connection established",
      "event_connection_closed": "Call connection closed",
      "event_connection_error": "Call connection error occurred",
      "event_user_connected": "User connected to the call",
      "event_user_disconnected": "User disconnected from the call",
      "event_client_connected": "Client connected to the call",
      "event_client_disconnected": "Client disconnected from the call"
    }
  }
}

​
Error Responses

{
  "message": "Missing Bearer Token"
}

{
  "success": false,
  "message": "Agent not found in this environment."
}