Eh/odoo ticket integration by erichugy · Pull Request #234 · botpress/growth

erichugy · 2026-01-19T16:26:09Z

Purpose

The goal of this PR is to introduce Odoo Helpdesk to the list of supported integrations. In this integration, we enable the ability to create customers, fetch customers (via Botpress ID, Odoo ID, or email), update customers (via ID or email), create helpdesk tickets, fetch tickets (via ticket ID, customer Odoo ID, or customer email), update tickets, get helpdesk teams, and get ticket stages.

…ce customer and ticket actions with new schemas, and improve state management for customer ID mapping.

Copilot

Pull request overview

This PR introduces a new Odoo Helpdesk integration for Botpress that enables management of helpdesk tickets and customers. The integration provides comprehensive CRUD operations for both tickets and customers, along with the ability to fetch helpdesk teams and ticket stages from Odoo.

Changes:

Added complete Odoo Helpdesk integration with authentication via JSON-RPC API
Implemented customer management (create, fetch by ID/email/Odoo ID, update)
Implemented ticket management (create, fetch, update) with support for teams, stages, and priorities
Added state management for caching helpdesk teams and customer ID mappings

Reviewed changes

Copilot reviewed 28 out of 29 changed files in this pull request and generated 23 comments.

Show a summary per file

File	Description
package.json	Updated pnpm package manager version to 10.28.0
integrations/odoo-helpdesk/package.json	Package configuration with dependencies for Botpress SDK and Axios
integrations/odoo-helpdesk/integration.definition.ts	Integration definition with configuration schema for Odoo API credentials
integrations/odoo-helpdesk/src/services/odoo.ts	Core service layer implementing Odoo authentication and API method execution
integrations/odoo-helpdesk/src/setup/register.ts	Registration handler that fetches and caches helpdesk teams and stages
integrations/odoo-helpdesk/src/setup/unregister.ts	Unregistration handler for cleanup
integrations/odoo-helpdesk/src/setup/helpdesk.ts	Helper functions to fetch helpdesk teams and stages from Odoo
integrations/odoo-helpdesk/src/actions/customers.ts	Customer action implementations (create, fetch, update)
integrations/odoo-helpdesk/src/actions/tickets.ts	Ticket action implementations (create, fetch, update)
integrations/odoo-helpdesk/src/actions/helpdesk.ts	Helpdesk actions to retrieve cached teams and stages
integrations/odoo-helpdesk/definitions/schemas/*.ts	Type definitions and Zod schemas for all domain models
integrations/odoo-helpdesk/definitions/actions/*.ts	Action definitions with input/output schemas
integrations/odoo-helpdesk/definitions/states.ts	State definitions for integration data storage
integrations/odoo-helpdesk/hub.md	Integration documentation (currently placeholder content)
integrations/odoo-helpdesk/icon.svg	Odoo logo icon for the integration
integrations/odoo-helpdesk/tsconfig.json	TypeScript configuration
integrations/odoo-helpdesk/version-bump-and-deploy.js	Utility script for version management and deployment

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-19T16:31:37Z

integrations/odoo-helpdesk/src/actions/tickets.ts

+  if (priority !== undefined) updatePayload.priority = priority
+
+  // Only update if there are fields to update
+  if (Object.keys(updatePayload).length === 0) return { success: true }


Explicit early return when no fields are provided is good practice. However, returning success: true when nothing was updated could be misleading. Consider throwing a RuntimeError with a clear message instead, similar to line 205.

Suggested change

if (Object.keys(updatePayload).length === 0) return { success: true }

if (Object.keys(updatePayload).length === 0) {

throw new RuntimeError('No fields provided to update the ticket.')

}

Copilot · 2026-01-19T16:31:37Z

integrations/odoo-helpdesk/src/services/odoo.ts

+    'Content-Type': 'application/json',
+    Cookie: cookie,
+  }
+  logger.forBot().info(`Odoo method: ${method} on model: ${model} executing with URL: ${url} and body: ${JSON.stringify(body)} and headers: ${JSON.stringify(headers)}`)


The cookie is being logged which could expose authentication session tokens. Consider reducing the log level or removing sensitive cookie information from logs to avoid potential security issues.

Suggested change

logger.forBot().info(`Odoo method: ${method} on model: ${model} executing with URL: ${url} and body: ${JSON.stringify(body)} and headers: ${JSON.stringify(headers)}`)

const { Cookie: _cookie, ...safeHeaders } = headers

logger

.forBot()

.info(

`Odoo method: ${method} on model: ${model} executing with URL: ${url} and body: ${JSON.stringify(

body

)} and headers: ${JSON.stringify(safeHeaders)}`

)

Copilot · 2026-01-19T16:31:38Z

integrations/odoo-helpdesk/src/services/odoo.ts

+  logger
+    .forBot()
+    .info(
+      `Executing Odoo method: ${method} on model: ${model} with args: ${JSON.stringify(args)} and kwargs: ${JSON.stringify(kwargs)}`
+    )
+
+  const url = `${odooApiUrl}/web/dataset/call_kw`
+  const body = {
+    jsonrpc: '2.0',
+    params: {
+      model,
+      method,
+      args: args ?? [],
+      kwargs: kwargs ?? {},
+    },
+  }
+  const headers = {
+    'Content-Type': 'application/json',
+    Cookie: cookie,
+  }
+  logger.forBot().info(`Odoo method: ${method} on model: ${model} executing with URL: ${url} and body: ${JSON.stringify(body)} and headers: ${JSON.stringify(headers)}`)
+  const response = await axios.post(url, body, { headers })
+
+  logger.forBot().info(`Odoo Request response data: ${JSON.stringify(response.data)}`)
+
+  if (response.data.error) {
+    logger.forBot().error(`Odoo API error: ${JSON.stringify(response.data.error)}`)
+    throw new Error(`Odoo API error: ${JSON.stringify(response.data.error)}`)
+  }
+
+  logger
+    .forBot()
+    .info(
+      `Odoo Request response data result: ${JSON.stringify(response.data.result)}`
+    )


Verbose logging of request and response bodies could expose sensitive data and create large log files in production. Consider using more selective logging (only log errors or use debug level) or sanitize sensitive fields from the logs.

Copilot · 2026-01-19T16:31:38Z

integrations/odoo-helpdesk/definitions/actions/helpdesk.ts

+  description: 'Get all stages',
+  input: {
+    schema: z.object({
+      teamId: z.number().title('Team ID').describe('The id of the team to get the stages for'),


The input schema for getStages action defines teamId as required, but the implementation allows it to be optional (checking if it exists). This creates a mismatch between the API contract and implementation. Either make teamId optional in the schema or remove the conditional check.

Suggested change

teamId: z.number().title('Team ID').describe('The id of the team to get the stages for'),

teamId: z.number().optional().title('Team ID').describe('The id of the team to get the stages for'),

Copilot · 2026-01-19T16:31:38Z

integrations/odoo-helpdesk/src/actions/customers.ts

+  }) as string | number
+
+  const odooId : number = typeof odooIdResult === 'number' ? odooIdResult : parseInt(odooIdResult as string, 10)


Type casting is being used here when Odoo's create method returns either a string or number. Instead of casting and parsing, consider defining a more specific return type or using a type guard to handle both cases more safely.

Copilot · 2026-01-19T16:31:43Z

integrations/odoo-helpdesk/src/services/odoo.ts

+
+// Cache cookies per configuration to avoid re-authenticating
+const cookieCache = new Map<string, string>()


The cookie caching uses an in-memory Map which will be lost when the integration restarts or scales horizontally. This could cause issues in production environments. Consider using persistent state storage or implementing proper session management with expiration.

Suggested change

// Cache cookies per configuration to avoid re-authenticating

const cookieCache = new Map<string, string>()

import NodeCache from 'node-cache'

// Cache cookies per configuration with expiration to avoid re-authenticating unnecessarily

const cookieCache = new NodeCache({ stdTTL: 3600, checkperiod: 120 })

Copilot · 2026-01-19T16:31:43Z

integrations/odoo-helpdesk/definitions/actions/customers.ts

+  description: 'Fetch a customer by odoo id',
+  input: {
+    schema: z.object({
+      id: z.string().title('ID').describe('The id of the customer to fetch'),


The fetchCustomerByOdooId action requires both 'id' and 'odooId' parameters, but the 'id' (Botpress ID) might not always be known when you have an Odoo ID. This makes the API awkward to use. Consider making the 'id' parameter optional since the implementation can handle fetching by odooId alone.

Suggested change

id: z.string().title('ID').describe('The id of the customer to fetch'),

id: z.string().title('ID').describe('The id of the customer to fetch').optional(),

Copilot · 2026-01-19T16:31:43Z

integrations/odoo-helpdesk/src/actions/tickets.ts

+  logger,
+}) => {
+  const cookie = await getAuthenticatedCookie({ ...ctx.configuration, logger })
+  const filters: any[] = [['partner_id', '=', customerOdooId]]


The filters variable uses 'any[]' type. Consider defining a proper type for Odoo filters to improve type safety throughout the codebase.

integrations/odoo-helpdesk/src/actions/tickets.ts

integrations/odoo-helpdesk/src/actions/customers.ts

…e Logging less verbose

AudricPnd

Solid first PR, I left multiple comments to help you understand our code quality standards. Here are the main issues:

Type Safety:

as unknown is forbidden
as casts should be avoided as much as possible
Non-null assertions (!) are forbidden
Create Zod response schemas for all Odoo API calls

Error Handling:

Try-catch missing in critical paths
Review logging strategy

Architecture/Logic:

Add cookie expiration logic + invalidate cache on config changes
Add pagination support for list operations
Implement proper cleanup in unregister hook

integrations/odoo-helpdesk/icon.svg

integrations/odoo-helpdesk/src/services/odoo.ts

integrations/odoo-helpdesk/src/actions/customers.ts

integrations/odoo-helpdesk/src/actions/tickets.ts

integrations/odoo-helpdesk/src/actions/customers.ts

integrations/odoo-helpdesk/src/services/odoo.ts

integrations/odoo-helpdesk/src/actions/customers.ts

integrations/odoo-helpdesk/src/actions/tickets.ts

integrations/odoo-helpdesk/src/actions/customers.ts

…ons. Created Zod Response Schemas for all Odoo API calls. Feat: Added Cookie expiration logic. Added pagination support for list opperations. Implemented Cleanup in unregister hook.

…ure and added axios retry logic - Introduced CustomerIdMappingService and TicketRepository for better separation of concerns. - Enhanced error handling in state management and Odoo API interactions. - Added axios-retry for improved API call resilience. - Updated action handlers to utilize new repository methods for customer and ticket operations. - Removed deprecated setup files and streamlined integration registration and unregistration processes.

…unused logger in odoo services. - Updated integration version and name for clarity. - Removed unnecessary logger parameter from CustomerIdMappingService. - Enhanced state payload validation in action handlers for better error handling. - Simplified customer ID mapping retrieval logic.

…deployment

erichugy added 10 commits January 13, 2026 17:17

Created initial odoo helpdesk typing and outline

df68a52

Created helpdesk and ticketing actions

808d2b1

Bug: Force to requthenticate

7e42bec

Managed to get the helpdesk teams and keep session alive

bd436c4

Feat: Odoo Registration and Helpdesk Teams and Stages

be82415

Creating customers

80e2f34

Update Odoo Helpdesk integration: bump package manager version, enhan…

9e78264

…ce customer and ticket actions with new schemas, and improve state management for customer ID mapping.

Fixed customer creation

85f84c7

Completed Create ticket to a final working state

1271a7e

Got Update to work

866e692

Copilot AI review requested due to automatic review settings January 19, 2026 16:26

erichugy requested a review from a team as a code owner January 19, 2026 16:26

Copilot started reviewing on behalf of erichugy January 19, 2026 16:26 View session

Added Readme for Odoo Helpdesk

d62bd32

Copilot AI reviewed Jan 19, 2026

View reviewed changes

erichugy added 3 commits January 19, 2026 13:21

Fix: Formatting, Integration Version and Name, More Strict Types

9a101ba

Fix: Reverting root package.json updates

409f70b

Fix: Made version 1.0.0 and renamed integration name

f30f9fe

erichugy marked this pull request as draft January 19, 2026 19:28

Fix: Removed unused Priority Class. Forced OdooId to be a number. Mad…

caa22f2

…e Logging less verbose

erichugy marked this pull request as ready for review January 19, 2026 19:33

erichugy added 3 commits January 19, 2026 14:35

Fix: Formatted with Prettier

5c96ce1

Chore: Added TTYL to cookie cache

366b0ac

Fix: Added copilot revisions

3d33904

AudricPnd reviewed Jan 19, 2026

View reviewed changes

Updated Logo

122cd38

erichugy marked this pull request as draft January 20, 2026 20:29

erichugy added 3 commits January 20, 2026 15:47

Fix: Removed as unknown, as casts when possible, Non-null asserti…

4ed650b

…ons. Created Zod Response Schemas for all Odoo API calls. Feat: Added Cookie expiration logic. Added pagination support for list opperations. Implemented Cleanup in unregister hook.

fix: Reverted integration definition for production

5943d20

Fix: Aligned customer schema with create customer function and schemas

570b103

erichugy added 4 commits January 21, 2026 11:46

Chore: Removed unused logger parameter

c72e19e

Fix: Shortened hub.md

5d11fb3

Fix: Applied prettier formatting

f220021

erichugy marked this pull request as ready for review January 21, 2026 18:27

Fix: Unregister the customerIdMapping in unregistration

b5bdd68

erichugy requested a review from ermek-botpress January 21, 2026 18:37

erichugy added 2 commits January 21, 2026 13:53

fix: Reverted integration definiition version and name for prodution …

c139058

…deployment

-  if (Object.keys(updatePayload).length === 0) return { success: true }
+  if (Object.keys(updatePayload).length === 0) {
+    throw new RuntimeError('No fields provided to update the ticket.')
+  }

	teamId: z.number().title('Team ID').describe('The id of the team to get the stages for'),
	teamId: z.number().optional().title('Team ID').describe('The id of the team to get the stages for'),

		}) as string \| number

		const odooId : number = typeof odooIdResult === 'number' ? odooIdResult : parseInt(odooIdResult as string, 10)


		// Cache cookies per configuration to avoid re-authenticating
		const cookieCache = new Map<string, string>()

-// Cache cookies per configuration to avoid re-authenticating
-const cookieCache = new Map<string, string>()
+import NodeCache from 'node-cache'
+// Cache cookies per configuration with expiration to avoid re-authenticating unnecessarily
+const cookieCache = new NodeCache({ stdTTL: 3600, checkperiod: 120 })

	id: z.string().title('ID').describe('The id of the customer to fetch'),
	id: z.string().title('ID').describe('The id of the customer to fetch').optional(),

Conversation

erichugy commented Jan 19, 2026

Purpose

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AudricPnd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants