Why it matters
The public API documentation is the primary resource for building integrations with Whippy. It provides guides, examples, and full endpoint references needed to implement and maintain API-based workflows.
Key Concepts
Developers Section: Area in the Whippy dashboard that contains API-related tools, including API keys, webhooks, and documentation.
Public API Documentation: External documentation site that explains how to use Whippy’s API, including guides, recipes, and endpoint references.
Recipes: Step-by-step examples for performing specific API actions, such as triggering AI voice calls or sending messages programmatically.
API Reference: Detailed technical reference for each API endpoint, including parameters, request and response formats, and example calls.
Step-by-Step: Open the Public API Documentation
Open the Whippy dashboard.
Locate the top navigation bar.
Click the code (</>) icon in the navigation bar.
Review the Developers section pages (API Keys, Webhooks, Documentation).
Click Documentation.
Allow the documentation to open in a new browser tab.
Tips and Best Practices
Keep the documentation tab bookmarked for quick access during development.
Use the Guides section when starting a new integration or learning common workflows.
Refer to Recipes for concrete, step-by-step examples of specific API actions.
Use the API Reference for precise details when implementing or debugging endpoints.
Troubleshooting
Issue | Possible Cause | Fix |
Documentation does not open | Pop-up or new tab blocked by browser | Allow pop-ups or new tabs for the Whippy dashboard |
Cannot find documentation link | Incorrect navigation area selected | Ensure you clicked the code icon in the top navigation bar |
Missing API details | Looking in guides instead of reference | Navigate to the API Reference section for endpoint-level details |