Using Incoming Webhooks as a Data Source in Zoho Writer

How to use incoming webhooks as a data source in Zoho Writer

Overview

Zoho Writer supports incoming webhooks as a data source to directly receive field values from third-party apps like Fillout, Shopify, or any custom app and use them for document generation, without needing to store the data elsewhere first. This enables you to fetch data in real-time from any app that can send webhook payloads and use it to populate documents instantly.

Prerequisites 

  1. Webhook enabled in external app
  2. Supported payload formats  
    1. JSON
    2. Form Data
    3. URL-encoded data
      1. Dot notation (e.g., customer.name)
      2. Underscore notation (e.g., customer_name)
    4. Arrays (single or multi-record)

Steps

How to configure incoming webhook as a data source  

  1. Open your merge template in Zoho Writer.
  2. In the Automate pane, Under Select Data Source, click + Add a data source to get started.
  3. Select Incoming Webhook.
  4. The Get Fields From Incoming Webhook dialog will open.
  5. Click Get Fields (or Update Fields if fields were previously fetched).
  6. Writer will list all keys received from the webhook payload under Fields from external app.
  7. Select the fields you want to use in the merge.
  8. Click Import.


Notes
Note
  1. Incoming webhook actions cannot start the merge using the selected webhook URL until this dialog is closed.
  2. Subform fields received through the webhook payload are imported as regular merge fields in the main field list, not as subform fields.

How to trigger merge with payload

  1. Copy the Generated Webhook URL.
  2. Paste it in the webhook / API destination field of the external application.
  3. In the external app, send the field values in the same format shown in the “Payload Code to Use” section
  4. If you select JSON, pass the values in the JSON structure shown.
  5. If you select Form-Data / URL Encoded, pass the values using the same field IDs shown in the table.

  6. Trigger the webhook once to send sample data. Zoho Writer will detect the keys and list them for field import.
Idea
To avoid mapping issues, make sure future webhook submissions follow the same payload format as shown in the Payload Code section.

How to generate a new webhook URL 

  1. Open your merge template in Zoho Writer.
  2. In the Automate pane, Under Select Data Source, click + Add a data source to get started.
  3. Select Incoming Webhook.
  4. The Get Fields From Incoming Webhook dialog will open.
  5. In Select incoming webhook URL, select Generate new webhook URL.
  6. Enter the following details:
    1. Webhook name (required)
    2. Description (optional)
  7. Click Create & Copy to generate the unique webhook URL.

You can now paste this webhook URL into the external application that will send field values to Zoho Writer.

NotesNote
You can generate multiple webhook URLs for different apps or workflows, and select whichever one you need later from the dropdown.

How to add document generation to existing Zoho Flow or Zapier workflows 

Prerequisites

  1. Webhook URL of the merge template in Zoho Writer. Refer these instructions to generate the webhook URL.

Steps

  1. Open your existing Zoho Flow or Zapier workflow in which you wish to add document generation.
  2. Insert a Webhook action card at the point where you want the document generation to occur (adjacent to the card providing the merge data)
  3. Configure the webhook action:
    1. Action Event: Select the POST method
    2. Paste the Zoho Writer template's webhook URL and map the necessary data fields from the preceding steps in your flow or zap into the webhook's payload. Ensure the keys in the payload exactly match the merge fields in the Writer's merge template.
  4. Save and test the action to ensure the data is successfully sent and the document is generated.

FAQ  

  1. Can the webhook payload automatically start the merge?  
    Not in this flow. For triggering merge automatically through webhook calls, refer to this page.

  2. Can I import only selected fields?  
    Yes. Only selected fields in the dialog will be added to the merge configuration.

  3. Can I import additional fields later from the same or a different webhook URL?
    Yes. After selecting an incoming webhook as a data source, you can click Import Fields at any time to fetch additional fields. You can use:
    1. the same webhook URL, or
    2. a different webhook URL
      If you choose a different webhook URL during import, it will be used only to fetch the fields and will not be displayed as a data source in the configuration panel. Only the primary selected webhook appears as a data source.

Troubleshooting 

Symptom
Possible Cause
Recommended Solution
Fields do not appear after clicking Get Fields
No payload received
Trigger a test event from the external application
Some expected fields missing
Payload has nested or renamed keys
Trigger payload again and click Update Fields
Fields show blank during merge
Mapping not completed
Check the Manage Fields section and re-map
Webhook rejected in external app
Wrong request type
Ensure the app sends the payload through HTTP POST
  1. How to trigger merge using an incoming webhook
  2. Control merge field rendering through field type settings  
  3. Managing data sources and their limits in Writer's mail merge

      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 FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile 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 FormsFormstack alternativeEncrypted Forms

                              Wufoo alternativeSecure Forms

                              TypeformWCAG

                                  All-in-one knowledge management and training platform for your employees and customers.

                                            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

                                                                                                                              • Configure workflow in Zoho Books with Writer's mail merge

                                                                                                                                Overview Use Zoho Writer with Zoho Books to create branded PDFs and automate document generation from your Books data. You can either use the Zoho Writer Templates extension in Zoho Books for one‑click document generation, or configure ...
                                                                                                                              • How to sort data in repeat blocks in merge templates

                                                                                                                                Overview You can organize your repeat table data by sorting it using specific merge fields. For example, to list employees by department, and then by their date of joining within each department, use the 'Sort Repeat Records' feature in Zoho Writer. ...
                                                                                                                              • How to trigger document merge in Zoho Writer

                                                                                                                                Overview Zoho Writer document merge can be triggered in four ways: manually, on a schedule, on form submission, or via an incoming webhook. This flexibility allows you to choose the most suitable automation method—whether you want to merge documents ...
                                                                                                                              • How to generate labels with Zoho CRM data using mail merge

                                                                                                                                Navigate to Settings from CRM Home. Under customization, click Templates > Mail Merge > New Template. Select a module. Assign a name to the template and pick a folder for the template to be saved and click Create, and select Blank. Insert a table and ...
                                                                                                                              • Getting started with document merge in Zoho Writer

                                                                                                                                Overview Zoho Writer’s template-based document generation lets you automatically create personalized documents by merging pre-designed templates with data from spreadsheets, forms, CRMs, or APIs. Merge fields pull in real data to generate contracts, ...
                                                                                                                                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