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

{
  "success": true,
  "message": "Test webhook sent successfully",
  "data": {
    "status_code": 200,
    "response_time": 150
  }
}

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

Sends a test payload to the webhook URL to verify connectivity and ensure your endpoint is properly configured to receive webhook events.

​
Endpoint

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

​
Request

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

​
Test Payload

When you call the test endpoint, the following payload will be sent to your webhook URL: 
{
  "event": "webhook.test",
  "agent_id": "9fbef0b7-8d4e-4a08-9207-66c22155721d",
  "agent_name": "My Agent",
  "webhook_id": "9fcafbf2-7593-44d6-8cd7-1b221beba62a",
  "webhook_name": "My Webhook",
  "timestamp": "2025-09-03T23:19:51.000Z",
  "test": true
}

​
Response

​
success
boolean
Indicates if the test webhook was sent successfully
​
message
string
Success message
​
data
object
Test results data
​
data.status_code
integer
HTTP status code returned by your webhook endpoint
​
data.response_time
integer
Response time in milliseconds
{
  "success": true,
  "message": "Test webhook sent successfully",
  "data": {
    "status_code": 200,
    "response_time": 150
  }
}

​
Error Responses

{
  "message": "Missing Bearer Token"
}

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

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

{
  "success": false,
  "message": "Webhook test failed: Connection timeout"
}

{
  "success": false,
  "message": "Webhook test failed: HTTP 500 Internal Server Error"
}

​
Important Notes

  • The test payload uses the webhook.test event type to distinguish it from real events
  • Your webhook endpoint should return a 2xx HTTP status code for successful tests
  • The test respects the webhook’s configured timeout and retry settings
  • Use this endpoint to verify connectivity before going live with webhook events
  • Test payloads include the test: true field to help identify them in your logs

​
Webhook Endpoint Requirements

Your webhook endpoint should:
  1. Accept POST requests with JSON payloads
  2. Return 2xx status codes for successful processing
  3. Respond within the configured timeout (default: 30 seconds)
  4. Handle the test event type appropriately
  5. Implement proper signature verification if using webhook secrets