Testing Methods
API Test Endpoint
API Test Endpoint
Send test webhooks programmatically:
Example: Test webhook response
Example: Test webhook response
Testing webhooks that use call data
A webhook that contains variables such as{{callAdditionalData.orderId}} needs stand-in values, because that data exists only on a real call.
- Dashboard: fill in Test values for custom data, which appears when the webhook references custom data, then click Test Webhook or Test Tool. Sample values are not saved.
- API: pass
callAdditionalDataandagentAdditionalDatain the test request, as in the example above, and include the webhook’scustomSettings.
sentRequest in the API response, to see the final URL, headers and body. A variable that still appears with its braces had no value in the test data.
See Request Templating for the full reference.
Testing with webhook.site
- Visit webhook.site
- Copy your unique URL
- Use as webhook URL in test API
- Inspect full request details
Local Testing with ngrok
Setup
Setup
Local Webhook Server
Local Webhook Server
Testing Workflow
Testing Workflow
http://127.0.0.1:4040 to inspect and replay requests.
Testing Event Types
StartWebHookPayload
StartWebHookPayload
ToolWebHookPayload
ToolWebHookPayload
Testing Retry Behavior
Testing Retry Behavior
Simulate failures to test retry handling:
Testing Idempotency
Testing Idempotency
Handle duplicate webhooks:
Debugging
Common Issues
Response Time Requirements
Quick Response Pattern
Quick Response Pattern
Pre-Production Checklist
- Webhook URL is publicly accessible
- Response time under required limit
- Idempotency handling for duplicates
- Error handling for all scenarios
- Logging enabled for debugging
- Tested all event types
Next Steps
- Configuring Webhooks — Set up webhook endpoints
- Webhook Events — Event types and payloads