Setup, access and model configuration

Verify the CRM and PHP requirements for OpenAI Integration

Check the supplied version requirements before activation or upgrade.

Audience: CRM administrators and authorised staffPermission: AdministratorModule v1.0.0

Exact navigationServer diagnostics and Admin Area → Setup → Modules → OpenAI Integration

Before you begin

Use an account with Administrator and confirm the intended record or setting before making a change.
Follow the exact route above. If the screen or action is absent, check module activation, ownership and permissions rather than using another person’s account.
Use controlled test data for configuration, integration, email, AI, payment, portal or automation changes before production-wide use.

What this guide covers

Check the supplied version requirements before activation or upgrade. The instructions reflect the supplied module’s registered menus, controller actions, views, settings and code-backed validation flow.

Exact step-by-step process

Open Server diagnostics and Admin Area → Setup → Modules → OpenAI Integration.
Select the relevant record, filter, report, model or configuration described below.
Use the displayed action or read the current values without altering unrelated data.
Compare the output with the code-backed rules and expected result in this guide.
Record or correct any mismatch before relying on the output in production.

Fields, choices and supported possibilities

ActionVerify the CRM and PHP requirements for OpenAI Integration

Exact navigationServer diagnostics and Admin Area → Setup → Modules → OpenAI Integration

Module version1.0.0

VerificationConfirm the saved record, status, output or setting in the same workspace and review any linked activity, file or notification.

Code-backed validations and workflow rules

Requires at least CRM 3.2.*.
composer.json requires PHP ^8.1.
The OpenAI PHP client and HTML-to-Markdown packages are loaded from the module vendor directory.

Expected result and verification

The supported verify the crm and php requirements for openai integration flow completes without bypassing permission or validation checks.
The resulting record, setting, status, file, delivery event or external response is visible from the relevant workspace.
Unexpected validation, provider or linked-record errors are investigated before retrying.

Security, privacy and operational checks

Restrict the API key and AI settings to authorised administrators.
Do not submit confidential, special-category or unnecessary personal data to the external AI provider.
Review generated text before using it in customer, staff, legal, financial or compliance communication.
Monitor provider billing and retention independently because this module has no built-in cost dashboard.