How to Create a Connection via Deluge in Zoho Writer?

How to Create a Connection via Deluge in Zoho Writer?

Overview   

Deluge connections in Zoho Writer allow you to securely integrate external services using authentication protocols. These connections can be leveraged in custom functions to retrieve or send data across platforms, enabling powerful automation and workflow customization.

Whether you're using default or custom services, Zoho Writer supports seamless document editing and real-time collaboration while integrating data from external applications.

With these connections, you can:
  • Fetch real-time data from external services directly into your Writer documents.
  • Push documents or data from Writer to third-party platforms — for example, automatically upload a merged document to Google Drive.

Prerequisites   

Before creating a connection in Zoho Writer:
  • You must have access to Zoho Writer.
  • Ensure you are using one of the automation templates (Merge, Fillable, or Sign).
  • For OAuth2 custom services:
    • Obtain Client ID, Client Secret, and API URLs (Authorize, Access Token, Refresh Token) from the third-party service.
    • Know the required scopes and supported grant type (Authorization Code or Client Credentials).
    • Ensure you register the correct Zoho callback URL in the third-party app.

Steps to Create a Connection in Zoho Writer   

 A. For Default Services   

  1. Access Deluge Editor in Zoho Writer: 
    • Open your document.
    • Navigate to Automate > Deluge Editor (available in Fillable, Merge, and Sign templates).
    • Click on Connections at the top-right.

  1. Create a Connection:
    • Click Go to Connections > Create Connection.
    • Under the Default Services tab:
      • Select the desired service.
      • Click Create Connection.
  1. Fill in Connection Details:
    • Connection Name: Display name for your reference.
    • Connection Link Name: Unique identifier used in Deluge scripts.
      • Must start with a lowercase letter.
      • Only lowercase letters, numbers, and underscores (_).
      • Max 50 characters.
    • Scope (if OAuth2): Specify as per the service’s API documentation.
  1. Click "Create and Connect":
    • Authorize the service.
    • Your connection will appear under My Connections.

 B. For Custom Services (OAuth2 Authentication)   

  1. Open Connections Page: 
    • Navigate to Deluge Editor > Connections > Go to Connections.
  1. Create Custom Service:
    • Go to Custom Services > Create New Service.
    • Enter the following:
      • Service Name: Display name (max 50 characters).
      • Service Link Name: Unique identifier (lowercase, alphanumeric, underscores).
  1. Choose Authentication Type:
    • Select OAuth2.
  1. Fill in OAuth2 Details:
    • Grant Type: Choose between Authorization Code or Client Credentials.
    • Client ID & Secret: Provided by the service.
    • Authorize URL, Access Token URL, Refresh Token URL: As per the API docs.
    • Param Type: How parameters are passed (Query string/Header).
    • Scope Delimiter: Default is comma, but space or plus is supported.
  1. Register Zoho Callback URL in third-party app:
  1. US: https://dre.zoho.com/delugeauth/callback
  2. EU: https://dre.zoho.eu/delugeauth/callback
  3. CN: https://dre.zoho.com.cn/delugeauth/callback
  4. IN: https://dre.zoho.in/delugeauth/callback
  5. AU: https://dre.zoho.com.au/delugeauth/callback
  6. JP: https://dre.zoho.jp/delugeauth/callback
  7. SA: https://dre.zoho.sa/delugeauth/callback
  8. CA: https://dre.zohocloud.ca/delugeauth/callback
  1. Click "Create Service":
    • Your custom service will be saved.
  1. Fill in Connection Details:
    • Same as default service steps:
      • Connection Name
      • Connection Link Name
      • Scopes (if required)
  1. Click "Create and Connect":
    • Authorize and finalize the connection.
  1. Connection will appear in "My Connections".

Troubleshooting   

1. Error/Symptom:Deluge Editor not visible in the Writer document
Possible Cause: You are not using a supported template (Merge, Fillable, or Sign).
Recommended Solution: Ensure you’re working within one of the supported automation templates in Zoho Writer.

2. Error/Symptom:OAuth2 connection setup fails or throws an error
Possible Cause: Incorrect Client ID, Client Secret, or missing/invalid callback URL.
Recommended Solution: Double-check your authentication credentials and ensure the callback URL is registered correctly in the third-party service’s developer console.

3. Error/Symptom:Scopes-related authentication failure
Possible Cause: Required scopes are missing or incorrectly formatted.
Recommended Solution: Refer to the third-party API documentation for the exact scopes and use the correct delimiter (comma, space, or plus).

4. Error/Symptom:“Link name already exists” error during connection creation
Possible Cause: The provided Connection Link Name is not unique.
Recommended Solution: Use a new, unique link name that follows the naming rules (lowercase, alphanumeric, underscores, max 50 characters).

5. Error/Symptom:Connection appears under “My Connections” but data fetch fails in function
Possible Cause: The connection was not authorized properly, or the scope is insufficient.
Recommended Solution: Recreate the connection ensuring proper scope and successful authorization.

FAQs   

Q1: Can I use the same connection in multiple custom functions?
Yes, once a connection is created, it can be reused across documents and functions.

Q2: What happens if I forget the scope?
If scope is required and not provided, authentication will fail. Always refer to the service’s API documentation.

Q3: What delimiter should I use for scopes?
By default, a comma (,) is used. If the API expects another format (space or plus), specify it in the Scope Delimiter field.

Q4: Can I edit a connection after it's created?
You cannot modify an existing connection. To change any parameter, you must create a new connection.

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure Forms

                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now






                                                        You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                            Manage your brands on social media


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                Zoho Sheet Resources

                                                                 

                                                                    Zoho Forms Resources


                                                                      Secure your business
                                                                      communication with Zoho Mail


                                                                      Mail on the move with
                                                                      Zoho Mail mobile application

                                                                        Stay on top of your schedule
                                                                        at all times


                                                                        Carry your calendar with you
                                                                        Anytime, anywhere




                                                                              Zoho Sign Resources

                                                                                Sign, Paperless!

                                                                                Sign and send business documents on the go!

                                                                                Get Started Now




                                                                                        Zoho TeamInbox Resources





                                                                                                  Zoho DataPrep Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • Related Articles

                                                                                                                        • How to Set Up Custom Workflows with Deluge Script in Zoho Writer?

                                                                                                                          Overview Custom Functions in Zoho Writer allow you to add automation, logic, and integrations to document workflows. Using Deluge scripts, you can program actions to occur immediately after a document is merged, filled, signed, PDF combined or when a ...
                                                                                                                        • Configure workflow in Zoho Books with Writer's mail merge

                                                                                                                          With the Zoho Books and Zoho Writer merge integration, you can easily generate customized documents, like shipping labels or invoices, directly from your Zoho Books data. For instance, if you need to create labels for customer orders that include ...
                                                                                                                        • Configure workflow in Zoho Projects with Writer's mail merge

                                                                                                                          Zoho Writer and Zoho Projects' integration allows collaboration and document management for project teams. Project managers can automate the creation of critical documents using Zoho Writer's custom functions and workflow rules. The integration also ...
                                                                                                                        • Configure workflow in Zoho Sprints with Writer's mail merge

                                                                                                                          The integration between Zoho Sprints and Zoho Writer simplifies the process of document generation, making it more efficient for teams managing projects. By utilizing template functions, you can create dynamic document templates that pull in data ...
                                                                                                                        • Managing Zoho Writer extensions

                                                                                                                          Extend the capabilities of Zoho Writer with extensions from Zoho Marketplace. This user guide will familiarize you with the procedure to install and manage Writer extensions. You can view all available Writer extensions on this page in Zoho ...
                                                                                                                          Wherever you are is as good as
                                                                                                                          your workplace

                                                                                                                            Resources

                                                                                                                            Videos

                                                                                                                            Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                            eBooks

                                                                                                                            Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                            Webinars

                                                                                                                            Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                            CRM Tips

                                                                                                                            Make the most of Zoho CRM with these useful tips.



                                                                                                                              Zoho Show Resources