Skip to content
Docs/odoo

Odoo

Embed the AskGPT chatbot on your Odoo website and automatically push captured leads into Odoo CRM.

Overview

AskGPT provides a native Odoo addon (askgpt_chatbot) that installs on your Odoo server. It does two things: injects the chat widget on every website page, and automatically creates a crm.lead record in Odoo CRM whenever a visitor submits their contact details through the chatbot.

  • One-click install — copy the module folder to your addons path, then install from the Apps menu
  • Configure Bot ID, position, and colors from Website → Configuration → Settings (no code required)
  • Lead sync — captured name, email, and phone are pushed to Odoo CRM in real time
  • Works with Odoo 14, 15, 16, and 17

Step 1 — Download the module

Go to your chatbot's Embed tab and click 'Download Odoo module'. A ZIP archive is generated in your browser containing the complete askgpt_chatbot addon with your Bot ID already referenced in the README.

  • Open your chatbot → Embed tab
  • Scroll to Platform install guides → Odoo
  • Click 'Download Odoo module' — a .zip file is saved to your computer
  • The ZIP contains: __manifest__.py, models/, and views/ (all required files)

Step 2 — Install on your Odoo server

Copy the extracted askgpt_chatbot folder into your Odoo addons directory and install it from the admin panel.

  • Extract the ZIP — you get an askgpt_chatbot/ folder
  • Copy it to your Odoo addons path (e.g. /opt/odoo/custom-addons/)
  • Restart Odoo: sudo systemctl restart odoo
  • Log in as admin → Apps → Update App List
  • Search for 'AskGPT' and click Install
💡The module only depends on the built-in website module — no extra Python packages required.

Step 3 — Configure the widget

After installation, configure the widget from Odoo's website settings.

  • Go to Website → Configuration → Settings
  • Scroll to the 'AskGPT Chat Widget' section
  • Paste your Bot ID (found on the AskGPT embed page)
  • Choose Bottom Right or Bottom Left position
  • Optionally enter primary/accent color overrides
  • Click Save — the widget appears on every page immediately
Bot ID location: AskGPT Dashboard → your chatbot → Embed tab → data-bot-id value

Step 4 — Enable Odoo CRM lead sync (optional)

When lead sync is enabled, every visitor who shares their contact details is automatically added as a lead in Odoo CRM. This is configured per-chatbot in the AskGPT dashboard via the API.

  • In Odoo: Settings → Users → [your user] → Action → API Keys → New — create an API key
  • In AskGPT: PATCH /api/chatbots/{id} with the integrations.odoo object below
  • The chatbot will push name, email, phone, and source page to crm.lead on each new lead
  • Failures are silently logged — they never interrupt the chat response
PATCH /api/chatbots/{botId} { "integrations": { "odoo": { "enabled": true, "url": "https://mycompany.odoo.com", "db": "mydb", "username": "admin@example.com", "apiKey": "your-odoo-api-key", "teamId": 1 } } }
💡teamId is optional — if set, leads are assigned to that CRM sales team. Omit it to use Odoo's default.

How the widget injection works

The addon extends Odoo's website.layout QWeb template, injecting an async <script> tag at the end of <body> when a Bot ID is configured. The widget loads from your AskGPT server URL and reads all settings (colors, position, welcome message) from the AskGPT API automatically — you don't need to set them in Odoo.

<!-- Injected automatically by askgpt_chatbot module --> <script src="https://askgpt.asksol.pk/widget.js" data-bot-id="YOUR_BOT_ID" data-position="bottom-right" async> </script>

Troubleshooting

Common issues when installing the Odoo module:

  • Module not found after update — confirm the folder is named exactly askgpt_chatbot (no spaces or extra chars)
  • Widget not visible — check that the Bot ID is saved in Website Settings and the chatbot is published in AskGPT
  • CRM leads not appearing — verify the API key is active, the Odoo URL has no trailing slash, and the db name matches exactly
  • Template error on install — run with --dev=all and check the Odoo server log for XML parse errors

Need more help?

Contact support and we'll get back to you within 24 hours.