fix (zoho-sales-iq-hitl): add tags to get or create user & upgrade to HITL plugin #238
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erichugy
commented
Jan 23, 2026
erichugy
commented
- throw error when tags passed to getOrCreateUser are not fruitful
- added zod schemas for request responses
- upgraded to use HITL plugin
- Migrate from deprecated HITL agent to HITL plugin architecture - Upgrade @botpress/sdk to 5.2.0 and @botpress/client to 1.28.0 - Update hitl interface to 2.0.0 - Add comprehensive error handling for failed conversation creation - Add debug response logging for API calls - Improve input validation for startHitl action - Refactor entity definitions to use ticket schema for hitlSession
Introduce comprehensive Zod-based type definitions for all Zoho Sales IQ API responses and webhook events. Replaces `any`/`unknown` types with properly validated schemas, adding runtime validation throughout the client, event handlers, and setup workflows. Includes new webhook-events.ts with structured event definitions and enhanced schemas.ts with API response wrappers.
…alls Created validation utility to ensure conversation IDs and user email IDs are non-empty before passing to client.getOrCreateConversation and client.getOrCreateUser functions. Updated all event handlers to use the new validation functions.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR upgrades the Zoho Sales IQ HITL integration to use the new HITL plugin (version 2.0.0) and adds comprehensive validation for webhook events and API responses using Zod schemas. The changes include improved error handling, removal of debug logging with sensitive data, and better type safety throughout the integration.
Changes:
- Upgraded from HITL plugin 0.4.0 to 2.0.0, and Botpress SDK from 3.3.0 to 5.2.0
- Added Zod schema validation for webhook events and API responses
- Implemented tag validation with error handling for getOrCreateUser and getOrCreateConversation
- Improved error handling with proper type guards and removed logging of sensitive information
- Added handlers for unsupported message types (bloc, file, video, audio, image)
Reviewed changes
Copilot reviewed 36 out of 39 changed files in this pull request and generated 21 comments.
Show a summary per file
| File | Description |
|---|---|
src/utils/validation.ts |
New validation utilities for conversation and user tags with error handling |
src/definitions/webhook-events.ts |
New Zod schemas for all webhook event types (operator replied, attender updated, conversation completed/missed) |
src/definitions/schemas.ts |
Added Zod schemas for OAuth, conversation creation, and app config responses |
src/setup/handler.ts |
Refactored to use schema validation instead of switch statement for event routing |
src/setup/unregister.ts |
Removed unused parameters |
src/events/*.ts |
Updated event handlers to use validated tags and new event types |
src/client.ts |
Improved error handling, removed sensitive logging, added response validation |
src/channels.ts |
Fixed error message, added unsupported message type handlers |
src/actions/hitl.ts |
Added validation for conversation creation, improved email checking, removed debug logs |
package.json |
Upgraded dependencies including SDK, client, CLI, and HITL plugin |
integration.definition.ts |
Added ticket entity definition and updated version to 3.0.1 |
bp_modules/hitl/* |
Removed generated interface files (to be regenerated by build) |
sample-logs.txt |
Added sample logs (contains sensitive data) |
.gitignore |
Added .claude directory |
Files not reviewed (1)
- integrations/zoho-sales-iq-hitl/pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
8 tasks
… handling Extract shared JSON schema definitions into dedicated literals file, improve validation error messages with detailed webhook event information, and strengthen input validation in action handlers.
Organize imports alphabetically, remove redundant comments, fix type assertions, and improve error handling across the codebase.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 39 out of 42 changed files in this pull request and generated 7 comments.
Files not reviewed (1)
- integrations/zoho-sales-iq-hitl/pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Horisofine
suggested changes
Jan 28, 2026
integrations/zoho-sales-iq-hitl/bp_modules/hitl/definition/actions/startHitl/input.ts
Outdated
Show resolved
Hide resolved
erichugy
changed the title
Co-authored-by: Houssam Eddine Righi <[email protected]>
Co-authored-by: Houssam Eddine Righi <[email protected]>
… handling Remove RuntimeError throws in favor of returning result objects. Auto-refresh credentials when missing and set access token expiry to 1 hour. Simplify sendMessage and getApp methods to return structured result objects. Add note that Zoho refresh tokens never expire.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 38 out of 41 changed files in this pull request and generated 3 comments.
Files not reviewed (1)
- integrations/zoho-sales-iq-hitl/pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.