Vixiees API

Welcome to the Vixiees API

The Vixiees API allows you to securely and efficiently integrate your systems with our platform, automate processes and synchronize data in real time. With a single X-API-Key, you can create and update contacts and deals, access recordings, send WhatsApp messages via approved templates and receive instant notifications through configurable webhooks.

Designed to be robust, scalable and easy to implement, the API offers predictable endpoints, clear limits and intelligent developer support.

What you can do with the API

• Contacts: create, update and receive changes automatically.
• Deals: create, update and receive changes automatically.
• Recordings: query and retrieve call recordings.
• Messaging: send WhatsApp Business templates.
• Webhooks: receive real-time events for contacts and deals.

Access and authentication

1. Go to Settings -> Account -> API.
2. Enable the API and copy your secret X-API-Key.
3. (Optional) Enable webhooks and set the Webhook URL. The API Key is sensitive - do not share it publicly.

Webhooks

• Enable or disable specific events from the same section.
• Set your receiving URL.
• Receive instant notifications when important changes occur.

Usage limits

• License-Based Scaling
  • Per minute: licenses x 25 requests
  • Per hour: x60
  • Per day: x24
• Hardcore limit: 40 requests / 2 s (independent of other limits).
• If any limit is exceeded, a 429 TooManyRequests response is returned with details and a link to developers.vixiees.com.

Pagination

• Max 100 records per page set.
• Use limit <= 100 and page=1 onwards.
• Filter by created_at or updated_at to segment results. Example: updated_at>=2025-08-07T00:00:00
• 422 Unprocessable Entity indicates the limit has been exceeded or the query is invalid.

Quick summary

Common Use Cases

1. Sync contacts to external CRM

• GET /contacts with updated_at_from filter for incremental sync
• Configure contact_updated webhook for real-time updates; when a contact enters a flow step the payload also carries action: flow_step_changed and changes ([previous, new] per field)

2. Send WhatsApp after form submission

• Configure submitted_form_created webhook
• POST /whatsapp_templates/{id}/send_message to send confirmation

3. Track deal pipeline

• Configure deal_updated webhook; when a deal is won, lost or reopened through its dedicated operation the payload also carries action (won, lost, reopened) and changes.status as [previous, new]
• GET /deals to sync current state to your BI tool

4. Automate task creation

• POST /tasks to create follow-up tasks via API
• Configure task_completed webhook for notifications

Error Responses

All endpoints return errors in this format:

 
{
  "error": "Error message",
  "details": { /* field-specific errors */ }
}

Common HTTP status codes:

• 400 - Bad request (invalid parameters)
• 401 - Unauthorized (invalid API key)
• 404 - Resource not found
• 422 - Validation failed
• 429 - Rate limit exceeded