curl --request POST \
--url https://api.iwy.ai/v1/tool/{id}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parameters": {
"city": "Paris"
}
}
'{
"success": true,
"execution_time_ms": 1234,
"tool": {
"id": "dcfae097-1b37-4444-bb0c-1a6abb0320fd",
"name": "get_weather"
},
"request_sent": {
"url": "https://webhook.example.com/weather",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"x-api-key": "[REDACTED]"
},
"payload": {
"tool_id": "dcfae097-1b37-4444-bb0c-1a6abb0320fd",
"tool_name": "get_weather",
"parameters": {
"city": "Paris"
}
}
},
"response_received": {
"status": 200,
"status_text": "OK",
"headers": {
"content-type": "application/json",
"content-length": "256"
},
"body": {
"temperature": 18,
"conditions": "Partly cloudy",
"humidity": 65
},
"content_type": "application/json"
}
}Tools
Test tool execution
Tests a tool by executing it with the provided parameters. This allows you
to verify that your webhook is configured correctly and returns the expected
response. You can also use validate_only to test parameter validation
without actually calling the webhook.
Use Cases
- Verify webhook configuration
- Debug failed tool calls
- Test parameter validation
- Develop and iterate on webhooks
POST
/
tool
/
{id}
/
test
curl --request POST \
--url https://api.iwy.ai/v1/tool/{id}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parameters": {
"city": "Paris"
}
}
'{
"success": true,
"execution_time_ms": 1234,
"tool": {
"id": "dcfae097-1b37-4444-bb0c-1a6abb0320fd",
"name": "get_weather"
},
"request_sent": {
"url": "https://webhook.example.com/weather",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"x-api-key": "[REDACTED]"
},
"payload": {
"tool_id": "dcfae097-1b37-4444-bb0c-1a6abb0320fd",
"tool_name": "get_weather",
"parameters": {
"city": "Paris"
}
}
},
"response_received": {
"status": 200,
"status_text": "OK",
"headers": {
"content-type": "application/json",
"content-length": "256"
},
"body": {
"temperature": 18,
"conditions": "Partly cloudy",
"humidity": 65
},
"content_type": "application/json"
}
}Authorizations
Your iwy Service API Key. Find it at app.iwy.ai/settings.
Include it in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Path Parameters
The unique identifier (UUID) of the tool
Body
application/json
Response
Tool test executed successfully
Whether the test was successful
Execution time in milliseconds
Validation status (for validate_only requests)
Human-readable message
Tool information
Show child attributes
Show child attributes
Details of the request sent to webhook
Show child attributes
Show child attributes
Response from the webhook
Show child attributes
Show child attributes