O'Chat

Set up the module

Configure O'Chat after installation: name your instance, register with the central server, and verify everything works.

Step 1: Configure your instance

  1. Go to Settings → scroll down to the O'Chat section
  2. Enter your Instance Name — a friendly name for your Odoo (e.g. "Acme Corp")
  3. Note your Instance UUID — this is automatically generated and uniquely identifies your instance
  4. Click Save

Instance UUID

The Instance UUID is your unique identifier. Share it with partners or clients so they can establish a connection to your instance.

Step 2: Register with the central server

O'Chat requires registration with our central server to enable communication between instances:

  1. In the O'Chat settings, click Register with Central Server
  2. The system will:
    • Generate a RSA-4096 encryption keypair
    • Send your public key to the central server
    • Receive your API key and webhook secret
  3. You'll see a confirmation message when registration is complete

Registration successful

Your instance is now registered. You can see your registration status in the settings.

Step 3: Verify network requirements

For O'Chat to function properly, ensure:

  • Outbound HTTPS: Your server must be able to reach the O'Chat central server
  • Inbound webhooks: The central server must be able to reach your Odoo instance's /ochat/webhook endpoint

If you're behind a firewall, you may need to whitelist the following:

  • Central server URL (provided during setup)
  • Your Odoo instance's public URL for webhook callbacks

Important for on-premise

Your Odoo instance must be publicly accessible (or accessible from the central server) for webhooks to work. If your instance is behind a NAT or VPN, you may need to configure port forwarding or a reverse proxy.

Troubleshooting

Registration fails

  • Check your internet connection
  • Verify the central server URL is correct
  • Check your Odoo server logs for detailed error messages

Webhooks not received

  • Ensure your Odoo instance is publicly accessible on HTTPS
  • Check that /ochat/webhook is not blocked by a firewall or reverse proxy
  • Verify your SSL certificate is valid

What's next?

Managing Connections

Learn how to connect with other Odoo instances

Messaging

Start sending encrypted messages