ECODrIx API Documentation

Authentication

All API requests require two headers for tenant identification and authorization:

x-api-key: your_api_key_here
x-client-code: ERIX_CLNT_XXXXXX

The x-client-code header identifies your tenant. The x-api-key authenticates the request. Both are issued during onboarding.

Base URL & routing. Every endpoint lives under a single canonical prefix — /v1/api — organised by domain: /v1/api/platform/* (billing, auth, admin), /v1/api/product/erix/* (CRM, automations, chat, commerce), /v1/api/product/laie/* (lead-gen engine), and /v1/api/infra/* (connect channels, storage, webhooks). The system health dashboard is the one exception, served at the root /health.

Rate limits: 100 req/min per tenant (burst: 200). Exceeding returns HTTP 429.

Quick Start

Install the official SDK to get started in seconds:

npm install @ecodrix/erix-api

import { ErixAPI } from '@ecodrix/erix-api';

const erix = new ErixAPI({
  baseUrl: 'https://api.ecodrix.com',
  apiKey: 'your_api_key',
  clientCode: 'ERIX_CLNT_XXXXXX',
});

// Create a lead
const lead = await erix.crm.leads.create({
  firstName: 'John',
  phone: '+919876543210',
  source: 'website',
});

// Fire an automation trigger
await erix.crm.automations.trigger({
  trigger: 'order_created',
  phone: '+919876543210',
  variables: { orderId: 'ORD-001', amount: '999' },
  createLeadIfMissing: true,
});

Leads

Full lifecycle management for contacts — create, update, move through pipelines, score, tag, archive, and convert.

Pipelines & Stages

Configure multiple sales funnels with custom stages. Each tenant can have unlimited pipelines (Sales, Support, Onboarding, etc.).

Lead Scoring

Automatic engagement scoring based on activity density, response time, and deal progression. Configurable per tenant.

Activities & Notes

Log calls, emails, meetings, and internal notes against leads. Full activity timeline per contact.

CRM Analytics

Conversion funnels, pipeline velocity, source attribution, and team performance metrics.

Automations — Rules & Triggers

The automation engine matches incoming events against configured rules and executes actions (WhatsApp, email, webhook, internal ops). Supports instant, delayed, and event-relative timing.

Supported Triggers

• lead_created — New lead enters the system
• stage_enter / stage_exit — Lead moves in pipeline
• tag_added / tag_removed — Tag modification
• deal_won / deal_lost — Deal outcome
• payment_captured — Payment confirmed
• whatsapp_incoming — Inbound WhatsApp message
• meeting_created / meeting.rescheduled — Calendar events
• appointment_reminder — Time-relative meeting reminders
• score_refresh — Lead scoring threshold crossed
• Custom events — Any user-defined event name (e.g. order_created, service_enrolled)

Action Types

• send_whatsapp — Send a WhatsApp template with mapped variables
• send_email — Send an email (template or custom HTML)
• webhook — HTTP callback to external service
• move_stage — Auto-move lead to a different pipeline stage
• add_tag / remove_tag — Tag operations
• assign_to — Auto-assign to team member
• create_task — Internal task creation

Timing Modes

• Instant (delay: 0) — Fires immediately when event occurs
• After trigger (delay: N minutes) — Fires N minutes after the event
• Before event — Fires N minutes before a scheduled event (meetings/appointments)
• At event — Fires at the exact time of the scheduled event
• After event — Fires N minutes after the scheduled event

Workflows

Multi-step automation flows with branching logic, delays, and conditional actions.

Sequences

Time-based drip sequences for nurturing leads over days/weeks.

Custom Events

Define and manage custom event triggers that your application can fire to invoke automations.

WhatsApp

Send template messages, manage broadcasts, receive inbound webhooks, and power two-way conversations via the WhatsApp Business API.

Email & Marketing

Send transactional and marketing emails via Amazon SES with open/click tracking, unsubscribe management, and template support.

Notifications

In-app and push notifications for team members — new leads, assignments, reminders, and system alerts.

Google Meet

Schedule, reschedule, and cancel Google Meet meetings. Automatic calendar event creation with meet links.

Smart Reminders

Automatic reminders at 1 hour and 15 minutes before meetings via WhatsApp or email. Configurable per automation rule.

Media & Storage

Upload and manage files (images, documents, videos) with S3-backed storage and CDN delivery.

Checkout & Payments

Generate payment links, track transactions, and handle Razorpay/Stripe webhooks for payment confirmation.

Job Queue

Distributed task processing with priority levels, retry policies, dead-letter queues, and real-time status tracking.

Health & Monitoring

System health checks, dependency status, and uptime monitoring.

LAIE — Lead Generation

AI-powered web scraping, lead enrichment, and competitor analysis for automated outbound prospecting.

LAIE — AI & Intelligence

AI-driven insights — competitor analysis, message generation, and intelligent lead prioritization.

LAIE — Voice & Transcription

Voice call recording, transcription, and AI summarization for sales calls.

API Explorer

Try any endpoint directly from the browser. Provide your API key and client code to make live requests.

// Response will appear here