Back to Top

Magento 2 ChatGPT Checkout Message Generator – Documentation

Updated 23 May 2024

Magento 2 ChatGPT Checkout Message extension enables the admin to generate and display automated messages for the user or the customer at the point of checkout. 

Admin can use the AI checkout message module to auto-generate messages shown to the customer at the checkout screen regarding their purchase.

This module tailors the messages and prompts displayed during the checkout process based on the individual customer’s name, type of purchase, and order ID through the use of artificial intelligence and natural language.

Check the overview for the working of the extension –



  • The module uses AI and customer data to provide personalized messages and prompts during the checkout process.
  • Admin can enable HTTPS servers in terms of security which plays a key role in ensuring security for the users.
  • The module seamlessly integrates with the website’s checkout process, ensuring a smooth and uninterrupted shopping experience for its customers.
  • Admin can use separate OpenAI API key enabling them to allow users requesting to be valid users and have access to use openAi services.
  • The module supports many language translations.
  • The module also supports ChatGPT versions 3.5 and 4.0.
  • The user can connect to a unique port.
  • Admin can check the response of the server through Postman.

Please note

  • HTTPS server is required from the customer.
  • If the hostname and required files are uploaded then the save configuration will take more time (approximately 2-3 minutes).
  • Requires HTTPS server if server setting is enabled.

What is the use of Socket.IO?

Socket.IO is a JavaScript library that enables real-time, bidirectional communication between clients and servers in web applications.

Searching for an experienced
Magento 2 Company ?
Find out More

It abstracts the underlying transport mechanisms, such as WebSockets or long polling, to provide a consistent interface for real-time communication.

Installation process

The installation is quite simple just like the standard Magento 2 extensions.

#1- Download Module:
Firstly, you need to log in to the Webkul Store, go to My Account>My Purchased Products section, verify, and then download and extract the contents of this zip folder on the system.

#2-Upload Folder:

Once the module zip is extracted, follow path src>app and then copy the app folder into the Adobe Commerce directory on the server as shown below:


#3-Run commands:

After uploading the module folder, you need to run the following commands in the Magento 2 root directory:

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

php bin/magento indexer:reindex

php bin/magento cache:flush

How to get the OpenAI Credentials?

Firstly the user has to create an OpenAI account and login to the user AI dashboard as shown in the corresponding image.


Now the user needs to click on the personal option available in the top-right corner which will be followed by a pop-up, then the user needs to select the View API Keys option.


A page will open and another option for creating a New Secret Key will be visible as shown in the screenshot.


Once, the user clicks on this button a pop-up will display with the API key. The user can copy the key from here with the help of the copy button.


Server Settings

Environment setup guide:

*Please make sure that the node server is already installed on the host.

After the module has been installed please follow the below steps:

Fill configuration details where 

Host = yourdomain (without protocol)

Port = 3000

Save configuration.

In your Magento root folder run the following command :

sudo apt-get update
sudo apt-get install npm
  • Then to install all the required packages, run the following command :
npm install
  • Flush the cache and reindex all.
  • If the CSP is configured in restricted mode then please run the below command after saving the host name and port number in the admin store.
php bin/magento setup:di:compile

To start server run:

npm start

To stop server run:

npm stop

That’s it your AI checkout messenger is operational.

Initial Admin Configuration:

To configure the ChatGPT checkout message, the admin has to proceed to store>configuration>AI checkout message as shown in the following image:


After accessing the Magento 2 AI checkout message module interface you need to fill out and set up settings according to your requirements.

General Settings:

  • Enable module: This option allows you to permit the module to start and stop functioning.
  • Store Name: Under this option you have to fill out your store name which you want the module should display at the point of checkout.

Server setting:

  • Port number: A port number is a logical address that identifies a network-based application on a computer. You can input the port number of your choice unless the value HTTPS enabled option is NO.
    • If the value of the HTTPS-enabled option is YES, then you have to type in the value of the Port number as provided by the server.
  • HTTPS Enabled: This option is used to enable your module on the local network if the value is set to NO.
    • Setting the value of the HTTPS option to YES, requires you to fill out more setting options, as shown in the image below.
  • Upload server Private Key file: You can get this file from your host provider, file name must be as server.key
  • Upload Server Certificate Key File: You can get this file from your host provider, file name must be as server.crt
  • Upload Server CA Bundle File: You can get this file from your host provider, file name must be as

OpenAI Credentials:

  • OpenAI API Key: An API key is a unique code that identifies your requests to the API. Your API key is intended to be used by you.

Storefront Workflow


The Customers will select the product/products at the store and add it to the cart then further proceed to checkout.

After adding products to the cart, customer needs to fill out their details along with the shipping address and then select out shipping method.


The customer needs to verify their details and proceed to place an order by clicking on the place order button.


After placing the order, the customer will get an auto-generated AI order message with the order ID on the checkout page as shown in the below snapshot:



That’s all about the “Magento 2 ChatGPT Checkout Message“. However, If you have any queries regarding the plugin, please contact us at Webkul Support System. 

Current Product Version - 4.0.0

Supported Framework Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x, 2.4.x

. . .

Leave a Comment

Your email address will not be published. Required fields are marked*

Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home

Table of Content