Guide to Install an Use Data Builder for Perfex CRM

Restful API & GraphQL for Perfex CRM

RESTful API & GraphQL — Developer Documentation

TASKS IN PROGRESS

Features processed and integrated in version 2.0.2

- (No tasks in progress)

TASKS COMPLETED (PENDING RELEASE)

- [New Feature] - Outbound Webhook Dispatcher with Pluggable Channel Architecture. (April 4, 2026)
- [New Feature] - WebhookEventBus: fires events on REST and GraphQL Create/Update/Delete operations. (April 4, 2026)
- [New Feature] - ChannelRegistry: extensible adapter registry (built-in: HTTP/cURL with HMAC-SHA256). (April 4, 2026)
- [New Feature] - FieldMapper: per-subscription field include/exclude/rename transformations. (April 4, 2026)
- [New Feature] - Admin UI for managing webhook subscriptions, testing, and viewing delivery logs. (April 4, 2026)
- [New Feature] - Webhook delivery audit log with response codes and timing. (April 4, 2026)
- [New Feature] - Automatic sensitive column redaction on outbound payloads. (April 4, 2026)
- [New Feature] - Hook `data_builder_register_webhook_channels` for third-party channel registration. (April 4, 2026)

P/S: These features will be integrated to meet the needs of customers using the module and requiring integration within the system.

VERSION HISTORY

Version 2.0.1 (April 1, 2026)

NEW

- Comprehensive "Testing with Postman" guide in the Public API Docs. (April 1, 2026)
- Intelligent sample data formatting for Postman Collection exports, automatically recognizing column types for realistic Request Bodies. (April 1, 2026)
- Dynamic GraphQL Template generator built into the API Explorer and Public Docs, supporting automatic query and mutation creation to simplify integration development. (April 1, 2026)
- "Testing with OpenAPI" documentation section with download link, Swagger UI / Insomnia import guides, and step-by-step ChatGPT Custom GPT Actions integration. (April 1, 2026)
- Real-world use case gallery for AI-powered CRM analysis (data analysis, project status, client insights, unpaid invoices, revenue reports, AI reports). (April 1, 2026)
- Multi-language HMAC code samples (PHP, Node.js, Python, cURL) with copy-to-clipboard in the Authentication section. (April 1, 2026)
- Automated HMAC pre-request script embedded in both Postman Collection exports (Public Docs + API Explorer) with `hmac_secret` collection variable. (April 1, 2026)
- Integrated "Toggle All" functionality for managing Allowed Tables. (April 1, 2026)
- Implemented per-token HMAC signature toggles for granular security control. (April 1, 2026)

FIXED

- Resolved blank URL issues in Postman Collection v2.1 export by structuring URLs with `{{baseUrl}}` integration. (April 1, 2026)
- Query parameters (page, per_page, sort, fields, filter) now correctly display in the Postman Params tab as optional inputs. (April 1, 2026)
- Fixed OpenAPI YAML export producing invalid `responses` format (sequences instead of status-code mappings) caused by PHP `array_merge()` re-indexing numeric-string keys; replaced with `+` operator. (April 1, 2026)

Version 2.0.0 (March 30, 2026)

NEW

- Public blank chart view for embedding via iframe. (March 20, 2026)
- Report groups: organize independent reports into tabbed navigation. (March 20, 2026)
- Custom filter presets per report view for conditional data display. (March 20, 2026)
- Column-level aggregation row (sum, avg, count) at report table footer. (March 20, 2026)
- Visual charts with date comparison (daily/weekly/monthly/quarterly/yearly). Supported types: Bar, Line, Area, Doughnut, Radar, Bubble, Combo (Bar+Line), Pie, Scatter, Stepped Line, Point-styling, Interpolation. (March 20, 2026)
- REST API: versioned read-only endpoints (/v1/) for querying Perfex CRM tables and Data Builder views; supports filtering, sorting, field selection, and cursor pagination with HATEOAS links. (March 20, 2026)
- GraphQL API: single-endpoint querying with query depth and complexity controls; auto-generated schema per table and view; introspection restricted to admin explorer context. (March 22, 2026)
- GraphQL Mutations: full CRUD via GraphQL (create, update, delete) with auto-generated InputObjectTypes, primary key detection, write scope enforcement, and security column exclusions. Compliant with GraphQL Spec §6.3.1. (March 22, 2026)
- API Tokens: scoped access keys (tables/views/GraphQL); IP allowlist (CIDR), domain allowlist, per-token rate limiting, optional HMAC request signing, and configurable expiry. (March 20, 2026)
- 7-stage security middleware pipeline (DDoS shield, CORS, Admin Session Bypass, auth, rate limiter, scope verifier, request logger); all errors returned as RFC 9457 Problem Details. (March 20, 2026)
- Admin Session Bypass (middleware): allows authenticated Perfex admins to call the API from within the same site (API Explorer sandbox) without a Bearer token. Governed by a configurable setting (data_builder_api_admin_session_bypass); verifies admin session + same-site Origin/Referer/XHR dynamically via base_url() — no hardcoded values. (March 22, 2026)
- API Explorer: endpoint browser, live sandbox, code generator (cURL/JS/PHP/Python), Postman v2.1 and OpenAPI 3.0 export. (March 20, 2026)
- Public blank chart view for embedding via iframe. (March 14, 2026)
- Report Export / Import JSON: portable report definition workflow for backup, sharing, and migration between environments. (March 27, 2026)
- Report Templates for no-SQL users: pre-built templates plus "Save as Template" to speed up report creation without SQL. (March 27, 2026)
- Template Group management: organize templates by business domains; useful when systems include extra tables from third-party modules. (March 27, 2026)

CHANGED

- Chart.js upgraded to 4.5.0, locally integrated. (March 15, 2026)
- Data Builder settings moved to Perfex core (Setup -> Settings -> Data Builder). (March 18, 2026)

Version 1.0.0 (March 10, 2026)

NEW

- Release version

Search Knowledge Base Articles

Aspernatur non omnis aperiam.