Reference>Cookbook
Cookbook
Short curl examples against your workspace API. The host matches your signed-in Zyene URL.
Send a request
bash
curl -X POST "https://app.zyenereviews.com/api/v1/requests/send" \ -H "X-API-Key: zy_..." \ -H "Content-Type: application/json" \ -d '{"customerName":"Alex","customerPhone":"+18165551234","channel":"sms"}'Send via SMS + email together
bash
curl -X POST "https://app.zyenereviews.com/api/v1/requests/send" \ -H "X-API-Key: zy_..." \ -H "Content-Type: application/json" \ -d '{ "customerName": "Alex", "customerPhone": "+18165551234", "customerEmail": "alex@example.com", "channel": "both" }'Zapier / generic webhook
Same engine as /api/v1/requests/send, but accepts the API key as a query string so Zapier's "Webhooks by Zapier" action works without a custom header. Field aliases (name, email, phone) keep mappings simple.
bash
curl -X POST "https://app.zyenereviews.com/api/webhooks/generic?key=zy_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Alex", "email": "alex@example.com", "phone": "+18165551234", "channel": "both" }'Page reviews
bash
curl "https://app.zyenereviews.com/api/v1/reviews?page=2&limit=50" \ -H "X-API-Key: zy_..."Analytics snapshot
bash
curl "https://app.zyenereviews.com/api/v1/analytics?days=14" \ -H "X-API-Key: zy_..."