Sends a sample payload to the tool’s webhook URL to verify it’s reachable. Returns the payload that was sent.
Production tool-webhook payload shape (this is what your webhook URL receives when the agent actually invokes the tool during a call, when config.payload_config.include_standard_metadata is true, the default):
{
"company_id": "uuid",
"agent_id": "uuid",
"agent_name": "string",
"call_id": "uuid",
"call_direction": "outbound" | "inbound" | "web_call",
"caller_number": "+972...",
"callee_number": "+972...",
"call_metadata": { "...": "exactly what you passed at POST /calls body.metadata" },
"call_variables": { "LeadName": "...", "AppointmentDate": "..." },
"<your_extraction_param>": "<what the AI extracted>"
}
call_metadata — the object you passed at call creation. Use this to carry CRM IDs (appointment_id, contact_id, calendar_id, etc.) that tool receivers need to route updates back to the right record. The agent never sees these keys (they’re not injected into the prompt).call_variables — the {{VariableName}} values substituted into the system prompt. Useful for echoing context (e.g. Slack alerts: “Noa booked an appointment for ”).GET /calls/{id} fetch.Setting include_standard_metadata: false strips the 9 standard-envelope fields and sends only static + extraction params. Rare — only useful for integrating with a target that rejects unexpected fields.
Documentation Index
Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt
Use this file to discover all available pages before exploring further.
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Test result
Exact payload delivered to the tool's webhook URL — mirrors the production shape described above. In test mode, call_metadata and call_variables are populated with illustrative example keys so downstream webhook platforms (Make, n8n, Zapier) can infer the nested shape during 'Determine data structure'.