Codexa CODEXA
CRM Documentation
v1.0.0
Getting Started
Core Modules
Developer API
Support Contact Support
Codexa CRM / Overview
Codexa CRM

A fully custom, Egyptian-built CRM system designed to help businesses manage customers, track sales, and automate follow-ups — all from one centralized, fast, and beautiful dashboard.

What is Codexa CRM?

Codexa CRM is a bespoke customer relationship management system built and maintained by Codexa for businesses across Egypt and the region. Unlike off-the-shelf solutions, it is tailored to your exact workflow, language preferences, and business processes.

The system is fully web-based, mobile-responsive, and can be integrated with WhatsApp, email, and your existing tools via a REST API.

Note

Each CRM deployment is configured specifically for the client. This documentation covers the standard feature set. Your instance may have additional custom modules.

Core Capabilities
Contact ManagementSales PipelineTask AutomationReports & AnalyticsInvoice GenerationWhatsApp IntegrationRole-Based AccessREST API
System Requirements
ComponentRequirementNotes
BrowserChrome 90+, Firefox 88+, Safari 14+Latest version recommended
InternetAny stable connectionMin 1 Mbps for real-time features
Screen1280×720 minimumOptimized for 1440×900+
MobileiOS 14+ / Android 10+Full mobile support
Codexa CRM / Quick Start
Quick Start

Get your Codexa CRM running in under 10 minutes. This guide covers initial login, adding your first contact, and setting up your pipeline.

Step-by-Step Setup
01
Log in to your CRM dashboard
Navigate to your unique Codexa CRM URL. Use your admin credentials. You'll be prompted to change your password on first login.
02
Configure company settings
Go to Settings → Company Profile. Add your logo, currency (EGP/USD), and timezone. This appears on all invoices and reports.
03
Invite your team members
Go to Settings → Users & Roles. Click "Invite User", enter their email and assign a role (Admin, Sales Rep, or Viewer).
04
Add your first contact
Go to Contacts → New Contact. Fill in Name, Phone, and Company. You can also bulk-import via CSV.
05
Create your first deal
Go to Pipeline → New Deal. Select the contact, set a value and close date, then drag it to the right stage.
Important

Do not share your admin credentials. Create individual accounts for each team member to maintain a proper audit trail.

Codexa CRM / Installation
Installation & Setup

Codexa CRM is a hosted SaaS product — nothing to install. Your instance is deployed by Codexa on managed infrastructure. For self-hosted licenses, follow the steps below.

Server Requirements
ResourceMinimumRecommended
CPU2 vCPUs4 vCPUs
RAM4 GB8 GB
Storage40 GB SSD100 GB SSD
OSUbuntu 20.04 LTSUbuntu 22.04 LTS
Node.jsv18+v20 LTS
DatabaseMySQL 8.0MySQL 8.0+
Environment Variables
# .env DB_HOST=localhost DB_PORT=3306 DB_NAME=codexa_crm JWT_SECRET=your_secret_key APP_PORT=3000 APP_URL=https://crm.yourdomain.com
Start the Server
npm install npm run migrate npm run seed npm run start:prod
Codexa CRM / Contacts
Contact Management

Every customer, lead, and partner lives here — with a full history of interactions, deals, tasks, and notes attached to each record.

Contact Fields
FieldTypeRequiredDescription
full_nameStringYesFull name of the contact
phoneStringYesPrimary phone (Egyptian format supported)
emailEmailNoEmail for automated communications
companyStringNoCompany or organization name
sourceEnumNoLead source: Instagram, Referral, Website…
tagsArrayNoCustom tags for filtering and segmentation
Tip

Use tags to segment contacts (e.g. "VIP", "Cold Lead", "Follow Up Q3"). You can then filter, assign tasks, and send bulk messages to any tag group.

Codexa CRM / Sales Pipeline
Sales Pipeline

A visual, drag-and-drop view of every deal at every stage. Track deal value, probability, expected close date, and assigned rep — all at a glance.

Default Pipeline Stages
New LeadContactedProposal SentNegotiationWonLost

Stages are fully customizable. Go to Settings → Pipeline to add, rename, or remove stages. Each stage can have a default probability (%) for weighted pipeline value calculations.

Deal Fields
FieldDescription
deal_nameName or description of the deal
valueDeal value in your configured currency
stageCurrent pipeline stage
close_dateExpected or actual close date
probabilityWin probability % (auto-set by stage or manual)
Codexa CRM / Tasks
Tasks & Follow-ups

Never let a lead go cold. Create follow-up reminders, assign them to team members, and get notified at exactly the right moment.

Task Types
CallEmailWhatsAppMeetingFollow UpSend ProposalCustom
Automation Rule Example
// Auto-create task when deal moves to "Proposal Sent" { "trigger": "stage_change", "to_stage": "proposal_sent", "create_task": { "type": "follow_up", "due_in_days": 3, "assign_to": "deal_owner" } }
Codexa CRM / Reports
Reports & Analytics

Make data-driven decisions with built-in reports covering pipeline, team performance, revenue forecasts, and lead sources.

ReportDescriptionExport
Pipeline SummaryTotal value and count by stagePDF / Excel
Won vs LostDeal outcomes over a date rangePDF / Excel
Team PerformanceDeals and revenue per sales repPDF / Excel
Lead SourcesWhere your best leads come fromPDF / Excel
Revenue ForecastWeighted pipeline for 30/60/90 daysPDF / Excel
Codexa CRM / API / Authentication
API Authentication

Codexa CRM uses JWT (JSON Web Tokens). All API requests must include a valid bearer token in the Authorization header.

Getting a Token
// POST /api/v1/auth/login { "email": "admin@company.com", "password": "your_password" } // Response { "token": "eyJhbGciOiJIUzI1NiIs...", "expires_in": "7d" }
Using the Token
Authorization: Bearer eyJhbGciOiJIUzI1NiIs... // Example with fetch() const res = await fetch('/api/v1/contacts', { headers: { 'Authorization': `Bearer ${token}` } });
Security Warning

Never expose your API token in client-side code or commit it to version control. Use environment variables and server-side calls only.

Codexa CRM / API / Endpoints
API Endpoints

Base URL: https://crm.yourdomain.com/api/v1

Contacts
GET/contactsList all contacts
GET/contacts/:idGet single contact
POST/contactsCreate contact
PUT/contacts/:idUpdate contact
DELETE/contacts/:idDelete contact
Deals
GET/dealsList all deals
POST/dealsCreate deal
PUT/deals/:id/stageMove deal to stage
Tasks
GET/tasksList tasks
POST/tasksCreate task
PUT/tasks/:id/completeMark complete
Reports
GET/reports/pipelinePipeline summary
GET/reports/performanceTeam performance
Codexa CRM / API / Webhooks
Webhooks

Receive real-time notifications when events happen in Codexa CRM. Use them to trigger actions in Zapier, n8n, or your own backend.

Available Events
contact.createddeal.createddeal.stage_changeddeal.wondeal.losttask.completedtask.overdue
Webhook Payload Example
{ "event": "deal.stage_changed", "timestamp": "2026-05-21T10:30:00Z", "data": { "deal_id": 42, "deal_name": "Website Redesign — ABC Co.", "from_stage": "proposal_sent", "to_stage": "negotiation", "value": 45000, "currency": "EGP" } }
Codexa CRM / FAQ
Frequently Asked Questions

Common questions about Codexa CRM. Can't find your answer? Email our support team.

Is my data stored securely?

Yes. All data is encrypted at rest and in transit using AES-256 and TLS 1.3. Hosted instances run on isolated servers with daily automated backups.

Can I import data from another CRM?

Yes. We support CSV imports for contacts and deals. We also offer a free data migration service for clients moving from HubSpot, Zoho, or any Excel-based system.

Is there a mobile app?

Codexa CRM is fully responsive and works on any mobile browser. A dedicated iOS/Android app is on our roadmap for Q3 2026.

Do you support Arabic?

Yes. Codexa CRM supports full RTL Arabic UI. Switch the language from Settings → Language. Egyptian date and number formats are also supported.

Can I customize the pipeline stages?

Absolutely. Go to Settings → Pipeline to add, rename, reorder, or remove stages at any time without losing existing deal data.