n8n-nodes-zoho-salesiq

n8n community node for Zoho SalesIQ REST API v2 using OAuth2. Token refresh is delegated to n8n through this.helpers.requestOAuth2.

Trigger support

This package includes a webhook trigger node that creates and deletes a SalesIQ webhook automatically during workflow activation/deactivation.

Trigger UI is form-based (dropdowns, toggles, and repeatable field groups). No JSON body editing is required for regular setup.

Use App ID Filter is disabled by default for Data webhooks, so app_ids is omitted unless explicitly enabled.

Authentication model

• Credential extends oAuth2Api.
• Uses authQueryParameters: access_type=offline.
• Uses authentication: body.
• Uses requestOAuth2 for all API calls.
• No manual refresh-token logic is implemented.

API base URL resolution order

Resolution order implemented in nodes/ZohoSalesIQ/GenericFunctions.ts:

1. Explicit credential override (SalesIQ API Base URL)
2. oauthTokenData.api_domain from OAuth token response
3. Fallback from selected regional OAuth URL

Official documentation references used for implemented operations

1. REST API overview and data center server URIs

• https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html

2. Get conversation details (Get)

• URL: GET /api/v2/{screen name}/conversations/{conversation_id}
• Scope: SalesIQ.conversations.READ
• Docs: https://www.zoho.com/salesiq/help/developer-section/get-conversation-details-v2.html

3. Get conversation list (Get Many)

• URL: GET /api/v2/{screen name}/conversations
• Scope: SalesIQ.conversations.READ
• Query params implemented from docs: page, limit, status, department_id, attender_id, fields, from_time, to_time, app_id, email, visitor_type, updated_till_time, updated_from_time, sort_by, reference_ids
• Pagination flag used from docs sample response: more_data_available
• Docs: https://www.zoho.com/salesiq/help/developer-section/get-conversation-list-details-v2.html

4. Send message by operator (Create)

• URL: POST /api/v2/{screen name}/conversations/{conversation-id}/messages
• Scope: SalesIQ.conversations.CREATE
• Implemented payload: JSON text
• Docs: https://www.zoho.com/salesiq/help/developer-section/send-message-operator-conversation-v2.html

5. Send message to latest conversation by visitor email (Create)

• URL: POST /api/v2/{screen name}/visitors/{email_id}/messages
• Scope: SalesIQ.conversations.CREATE
• Implemented payload: JSON text
• Docs: https://www.zoho.com/salesiq/help/developer-section/rest-api-send-recent-conversation-email-v2.html

6. Pick up chat (Update)

• URL: PUT /api/v2/{screen name}/conversations/{conversation_id}/pickup
• Scope: SalesIQ.conversations.UPDATE
• Docs: https://www.zoho.com/salesiq/help/developer-section/pickup-chat-v2.html

7. Close chat (Update)

• URL: PUT /api/v2/{screen name}/conversations/{conversation_id}/close
• Scope: SalesIQ.conversations.UPDATE
• Docs: https://www.zoho.com/salesiq/help/developer-section/close-chat-v2.html

8. Webhooks lifecycle (Trigger)

• Create webhook
  • URL: POST /api/v2/{screenname}/webhooks
  • Scope: SalesIQ.webhooks.CREATE
  • Docs: https://www.zoho.com/salesiq/help/developer-section/create-webhook-v2.html
• Get webhook details
  • URL: GET /api/v2/{screenname}/webhooks/{id}
  • Scope: SalesIQ.webhooks.READ
  • Docs: https://www.zoho.com/salesiq/help/developer-section/get-details-webhook-v2.html
• Delete webhook
  • URL: DELETE /api/v2/{screenname}/webhooks/{id}
  • Scope: SalesIQ.webhooks.DELETE
  • Docs: https://www.zoho.com/salesiq/help/developer-section/delete-webhook-v2.html

Ambiguity flags

• Some operation pages include a downloadable OAS, while some do not.
• For consistency and to avoid undocumented behavior, this node currently sends JSON payload for message creation (text) and does not implement multipart file upload in the message APIs.
• The Create Webhook doc states SalesIQ validates webhook URL using an HTTP HEAD request before creation. n8n trigger webhooks are configured with POST for event delivery. Runtime behavior of HEAD validation against the n8n webhook endpoint may vary by deployment setup.

Build

npm run typecheck
npm run build

Publish safety

Check existing versions before publishing:

npm view @trg-admin/n8n-nodes-zoho-salesiq versions --json

If the target version exists, bump before publish:

npm version patch
npm publish --access public