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'
const response = await fetch('https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/test', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
});
const data = await response.json();
<?php
$client = new \GuzzleHttp\Client();
$response = $client->post('https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/test', [
'headers' => [
'Authorization' => 'Bearer YOUR_TOKEN',
],
]);
$data = json_decode($response->getBody());
{
"success": true,
"message": "Test webhook sent successfully",
"data": {
"status_code": 200,
"response_time": 150
}
}
Agent Webhooks
Test Webhook
Send a test payload to verify webhook connectivity
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'
const response = await fetch('https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/test', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
});
const data = await response.json();
<?php
$client = new \GuzzleHttp\Client();
$response = $client->post('https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/test', [
'headers' => [
'Authorization' => 'Bearer YOUR_TOKEN',
],
]);
$data = json_decode($response->getBody());
{
"success": true,
"message": "Test webhook sent successfully",
"data": {
"status_code": 200,
"response_time": 150
}
}
Overview
Sends a test payload to the webhook URL to verify connectivity and ensure your endpoint is properly configured to receive webhook events.Endpoint
string
required
Agent UUID
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'
const response = await fetch('https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/test', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
});
const data = await response.json();
<?php
$client = new \GuzzleHttp\Client();
$response = $client->post('https://app.talkover.ai/api/v1/agents/9fbef0b7-8d4e-4a08-9207-66c22155721d/webhooks/9fcafbf2-7593-44d6-8cd7-1b221beba62a/test', [
'headers' => [
'Authorization' => 'Bearer YOUR_TOKEN',
],
]);
$data = json_decode($response->getBody());
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
boolean
Indicates if the test webhook was sent successfully
string
Success message
object
Test results data
integer
HTTP status code returned by your webhook endpoint
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.testevent 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: truefield to help identify them in your logs
Webhook Endpoint Requirements
Your webhook endpoint should:- Accept POST requests with JSON payloads
- Return 2xx status codes for successful processing
- Respond within the configured timeout (default: 30 seconds)
- Handle the test event type appropriately
- Implement proper signature verification if using webhook secrets
Related endpoints
- List Agent Webhooks - Get all webhooks for an agent
- Create Webhook - Set up a new webhook
- Get Webhook Details - Retrieve specific webhook information
- Update Webhook - Modify webhook configuration
- Delete Webhook - Remove webhook configuration
- Toggle Webhook Status - Enable/disable webhook
Was this page helpful?