|API Documentation
Ryvet API
Use the Ryvet API to access your leads, chat transcripts, and flow data. All endpoints require authentication via an API key.
Base URL
https://api.ryvet.ioAuthentication
All API requests must include your API key in the X-Api-Key header.
Getting your API key
- Go to Account Settings
- Scroll to the API Keys section
- Click Generate New Key and copy it
curl -H "X-Api-Key: rk_live_abc123..." \
https://api.ryvet.io/api/v1/auth/meRate Limits
API requests are limited to 100 requests per minute per API key. If you exceed this limit, you will receive a 429 response.
Zapier Integration
Ryvet integrates with Zapier through polling triggers. When setting up your Zap, you will need your API key for authentication.
New Lead Trigger
Fires when a new form or quiz is completed. Includes all field values, quiz score, and result tier.
New Chat Trigger
Fires when a chat conversation completes. Includes the full transcript, lead data, and quiz results.
Authentication
Leads
Chats
Flows
Quiz Flows
When a quiz flow is completed, the lead response includes two additional fields:
quiz_score— The numeric score (e.g., 80)quiz_result— The result tier name (e.g., "Expert")These fields are null for non-quiz flows.
Error Codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 401 | Invalid or missing API key |
| 404 | Resource not found |
| 429 | Rate limit exceeded |
| 500 | Internal server error |