Skip to main content
PATCH
/
api
/
v1
/
agents
/
{agent_id}
/
webhooks
/
{webhook_id}
/
toggle
curl -X PATCH \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/toggle' \
  -H 'Authorization: Bearer YOUR_TOKEN'

{
  "success": true,
  "message": "Webhook enabled",
  "data": {
    "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:50:15.000000Z",
    "events_count": 2,
    "status": "active"
  }
}

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

Toggles the enabled/disabled status of a webhook. This is useful for temporarily stopping webhook notifications without deleting the configuration.

​
Endpoint

​
agent_id
string
required
Agent UUID
​
webhook_id
string
required
Webhook UUID

​
Request

curl -X PATCH \
  'https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/toggle' \
  -H 'Authorization: Bearer YOUR_TOKEN'

​
Response

​
success
boolean
Indicates if the webhook status was toggled successfully
​
message
string
Status message indicating whether webhook was enabled or disabled
​
data
object
Updated webhook object with new enabled status
​
data.id
string
Unique webhook identifier
​
data.agent_id
string
Agent UUID this webhook belongs to
​
data.name
string
Webhook name
​
data.webhook_url
string
Webhook URL
​
data.events
array
Array of configured event types
​
data.timeout
integer
Request timeout in seconds
​
data.max_retries
integer
Maximum retry attempts
​
data.enabled
boolean
New webhook status (toggled from previous state)
​
data.created_at
string
ISO 8601 timestamp when webhook was created
​
data.updated_at
string
ISO 8601 timestamp when webhook was last updated
​
data.events_count
integer
Number of events configured for this webhook
​
data.status
string
Current webhook status
{
  "success": true,
  "message": "Webhook enabled",
  "data": {
    "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:50:15.000000Z",
    "events_count": 2,
    "status": "active"
  }
}

{
  "success": true,
  "message": "Webhook disabled",
  "data": {
    "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": false,
    "created_at": "2025-09-03T23:19:51.000000Z",
    "updated_at": "2025-09-03T23:50:15.000000Z",
    "events_count": 2,
    "status": "disabled"
  }
}

​
Error Responses

{
  "message": "Missing Bearer Token"
}

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

{
  "success": false,
  "message": "Webhook not found."
}

​
Important Notes

  • This endpoint toggles the current enabled/disabled status of the webhook
  • Disabled webhooks will not receive any events until re-enabled
  • Webhook operations automatically clear the agent cache for immediate effect
  • Use this endpoint for temporary webhook management without losing configuration