Setup and details

This article covers Odoo 19. Running Odoo 18? See Odoo 18, it is set up differently.

Odoo does not offer OAuth flows, so the integration authenticates with a user-level API key: it acts as the user who issued the key and inherits exactly the permissions that user has in Odoo (what they can access, modify or delete). On Odoo 19, uman works with your instance over the JSON-2 API.

Data mapping

The table below shows what the integration reads from and writes to your Odoo, object by object.

uman object	Odoo model	What uman reads	What uman writes
Account	res.partner	Name	Creates Companies (name + any other required field)
Contact	res.partner	First name, last name, email, phone, title and the linked Company	Creates or updates Contacts (first name, last name, email, phone, title, the linked Company + any other required field)
Deal	crm.lead	Name, stage, pipeline, close date and the linked Company	Creates Leads (name, stage, pipeline, the linked Company) and updates the stage + any other required field
Pipeline	crm.team and crm.stage	Sales teams and their stages	Read only
Note	mail.message	Messages attached to a Company, Contact or Lead	Creates or updates Messages (title and content). Every message is linked to a Company, Contact or Lead
Custom object	Any Odoo model	Fields required to create a Company, Contact or Lead	Objects required to create a Company, Contact or Lead, with any field those objects require

The integration also uses res.users and res.users.apikeys (the connected user and their API keys) and ir.module.module (installed modules).

API keys on Odoo 19

An Odoo 19 API key expires after 3 months at the most.
uman renews the key for you before it expires, so your team does not have to reconnect every quarter. This needs the one-time administrator setup below.
The key uman creates for rotation is named uman-integration-key, so you may see a key with that name appear on your Odoo account after you connect.

Setup Instructions

Connecting Odoo 19 takes two parts: a one-time setup by an administrator, and a personal connection by every uman user who works with your CRM.

Administrator setup

1. Allow uman to renew API keys

Browse to your Odoo homepage and open Settings.
Under General Settings, go to Developer tools and activate developer mode. Without it, the Technical menu stays hidden.
Go to Settings > Technical > System Parameters.
Set the parameter base.enable_programmatic_api_keys to True. If it is not in the list yet, click New in the top right and add it.

Without this parameter, uman cannot renew API keys: every key expires after 3 months and each user has to create and paste a new one.

2. Give the connecting users Sales access rights

Every user who connects Odoo to uman needs Sales access rights, at least User: Own Documents Only. These permissions are required to access the objects uman requires from Odoo.

Go to Settings > Users & Companies > Users and open the user.
On the Access Rights tab, update the Sales value.

3. Connect your uman workspace with your Odoo instance

Browse to your uman workspace and open the Settings menu.
Go to Apps under the Workspace section.
Click on the Connect button under the Odoo 19 option and provide the following data:
- The instance URL of your Odoo application, for example https://mycompany.odoo.com
- The database name of the Odoo instance uman should connect to

Sales user setup

1. Create your API key in Odoo (official documentation)

Browse to your Odoo homepage and click your avatar in the top right.
Click My Preferences, then open the Security tab.
Under API Keys, click Add API Key (you might need to provide your password).
Enter a name and duration.
As of Odoo 19.4 you also pick a scope for the key: choose RPC.
Click Generate Key and copy the generated API key from the popup window.

2. Connect uman to Odoo 19

Browse to your uman homepage.
Click the settings cogwheel in the bottom left.
In the Personal section, click Apps.
Click the Connect button under Odoo 19.
Paste your newly generated API key into the field, and fill in Email with the email address you use to log in to Odoo.

FAQ

Why does uman need our database name?

One Odoo instance can host several databases. uman sends the database name with every request, so your data is always read from and written to the right one.

Can we connect Odoo once for the whole workspace instead?

No, every user connects with their own API key and works within their own Odoo permissions. Records they create or update in Odoo are attributed to them.

What happens when someone's Odoo permissions change?

The integration follows them: the API key can only reach what that user can reach in Odoo. If they lose access to a record, uman loses it too.

For further assistance, please contact our support team.