Integrations · REST API
Documented, versioned, idempotent REST API
Each endpoint follows Stripe/Twilio conventions: cursor pagination, idempotency key required for POST, structured errors.
Bearer token authentication
integrations.api.sections.authText
Main endpoints
Conversations, messages, departments, categories, macros, hold reasons, SLA configs, message templates, KB, FAQ, tags, operator status, webhook endpoints, audit log.
Versioning
Route /v1/ fixed. When v2 ships, it coexists with v1 for at least 12 months, with Sunset header (RFC 8594) starting 6 months in advance.
Example: create a conversation
bash
curl https://api.vaidesk.com/v1/conversations \
-X POST \
-H "Authorization: Bearer vd_live_a3b1f7e2_4f8a9c2d..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 8e3a..." \
-d '{
"external_user_id": "user_123",
"subject": "Question about plan",
"initiated_by_side": "end_user"
}'Ready to integrate robust customer support into your product?
Tell us about your case. We get back within one business day.