Skip to content
Docs
Voxbi Cockpit APIs
API Guides

Odoo integration

The Odoo integration pushes your PBX SIP connection settings into Odoo's VoIP module so users can place and receive calls from inside Odoo.

Overview

The Odoo integration is one of the integration types you configure under Integrations. It connects your PBX to an Odoo ERP instance and provisions the Odoo VoIP module with the SIP settings your users need to call through the PBX.

What it does

Once configured and activated, the integration provisions Odoo's VoIP module with the SIP connection details for your PBX users. The sync is one-way, from the PBX into Odoo, and it overwrites the matching SIP configurations already in Odoo. Treat the PBX as the single source of truth: any SIP settings you change manually inside Odoo are replaced on the next sync.

You provide four connection credentials so the PBX can reach your Odoo instance:

  • ServerUrl - the address of your Odoo instance, for example https://mycompany.odoo.com.
  • DbName - the Odoo database to write to.
  • Login - the Odoo username used for API access.
  • ApiKey - an API key generated in Odoo under your user settings. Use a key, not your account password.

A single switch controls the behavior:

  • Sync sip configurations to odoo voip - when turned on, the Odoo VoIP module is installed or updated and the SIP connection settings are pushed to Odoo for all PBX users. When off, no SIP push happens.

Two fields are generated for you and shown read-only. You cannot edit them, but you can copy them if Odoo asks for the values:

  • Odoo voip websocket - the WebSocket URL the Odoo VoIP module uses to reach the PBX. It is derived automatically from your PBX instance name.
  • Odoo pbx dns - the PBX server address, derived from your server configuration. This field appears only when a server is attached to the PBX.

The push does not run the instant you save. The integration moves through a status lifecycle - pending, processing, then success or failed - shown as a colored status pill in the integrations list. An external process picks up active integrations still waiting to be installed, applies the configuration, and reports the outcome back to the PBX. Saving a change resets the integration to pending so it is processed again.

See also

  • Integrations - the integration entity and its full field reference.
  • Users - whose SIP settings are pushed to Odoo.

Updated