API Reference

Connect VietGrow workflows to every client channel.

Reference patterns for lead capture, Messenger conversations, booking automation, review requests, ad attribution, and weekly owner reporting.

Base rules

AuthenticationBearer token per client workspace

IdempotencyUse Idempotency-Key for lead and booking writes

Rate limits300 requests per minute per workspace

Webhookslead.created, booking.confirmed, review.received, report.ready

Create lead

/api/leads

POST

Request

{ "name": "Mia Tran", "phone": "+1 415 555 0198", "service": "Botox consultation", "source": "facebook_ads" }

Response

{ "leadId": "lead_8K2", "status": "qualified", "nextAction": "send_sms_follow_up" }

Start conversation

/api/conversations

POST

Request

{ "channel": "messenger", "business": "Golden Gate Wellness", "goal": "book consultation" }

Response

{ "conversationId": "conv_31A", "handoff": false, "reply": "What service are you interested in?" }

Send review request

/api/reviews/request

POST

Request

{ "customerId": "cus_104", "visitId": "visit_455", "platform": "google" }

Response

{ "status": "queued", "sendAt": "2026-07-03T18:00:00-07:00" }

Weekly performance report

/api/reports/weekly

GET

Request

?client=golden-gate-wellness&week=2026-06-29

Response

{ "leads": 147, "bookings": 68, "adSpend": 1240, "reviews": 37, "nextActions": 4 }

Webhook handling

Use webhook events to update the owner dashboard, notify staff, trigger SMS follow-up, or pause campaigns when a booking is confirmed. Always verify the workspace token before processing an event.