Query Params in Webhook Block
When you want to pass extra information along with your API request, like a ticket ID, customer email, or a specific status, query parameters come in handy. These small but powerful additions to your API URL help external systems understand exactly what you’re trying to fetch, filter, or send.
Let’s understand what they are, how to use them, and why they matter.
What are Query Parameters?
Query parameters are key-value pairs added at the end of an API URL. They help fine-tune your API request to get the specific data you want or send relevant details to the server.
You’ll recognize them by the way they appear in URLs, such as:
https://api.example.com/tickets?ticketId=12345
In this example:
- ticketId is the key
- 12345 is the value
You can also pass multiple parameters by separating them with an ampersand (&)
https://api.example.com/tickets?ticketId=12345&status=Open&priority=High
This way, you’re telling the system: “Give me ticket 12345 that is Open and marked as High priority.”
Why use Query Parameters?
Query parameters help you:
- Get only the data you need instead of fetching everything
- Filter results based on conditions like status, priority, or date
- Pass user or ticket-specific details dynamically during a bot conversation
- Avoid sending unnecessary information in the request body
Where do you use them?
In the Webhook block of your bot flow, you’ll see an option to add Query Parameters. This is where you can enter the key and value pairs you need.
Here’s what that might look like:
- Key: ticketId
- Value: @ticket.id
- This tells the bot to take the current ticket’s ID and pass it to the API dynamically.
You can add up to 20 query parameters in one Webhook request.
Examples
Examples
1. If you want to get the details of a specific ticket using an external system:
API URL: https://api.example.com/tickets
Query Param:
- Key: ticketId
- Value: {{ticket.id}}
Final request:
https://api.example.com/tickets?ticketId={{ticket.id}}
2. Let’s say you only want to fetch tickets that are currently “Open”:
API URL: https://api.example.com/tickets
Query Param:
- Key: status
- Value: Open
Final request:
https://api.example.com/tickets?status=Open
3. Fetch Multiple Associated Details
Some APIs (like Zoho Desk’s) allow you to include related modules like contacts or products along with the main request.
For example:
https://desk.zoho.com/api/v1/tickets/1892000000143237?include=contacts,products,assignee,departments,team
Here, the include parameter is used to ask Zoho Desk to return extra data related to the ticket, such as:
- Contact associated with the ticket
- Products linked
- Assigned agent
- Department and team involved
Benefits of using Query Parameters
- Keep your API requests clean and simple
- Avoid over-fetching data; get only what you need
- Make your bot more dynamic by passing real-time user inputs
- Stay aligned with best practices for most REST APIs
Tips
- Always refer to the API documentation to know what parameters are supported.
- Use variables (like {{ticket.id}} or {{user.email}}) to personalize requests.
- Query parameters are optional but very useful; don’t ignore them if you need filtering.
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 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 Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Request Timeout in Webhook Block
When your chatbot connects to an external service, it uses a webhook block to send a request to that service’s API. Now imagine the service takes too long to respond. What should your chatbot do? Wait forever? Give up too early? That’s exactly what ...Connections in Webhook Block
When you’re working with webhooks in a bot flow, whether you’re retrieving data, updating a record, or triggering a third-party service, you often need to establish a secure connection with an external application. That’s where Connections come into ...URL Field in Webhook Block
Where it knows to go! You’ll need to enter the exact REST API endpoint of the third-party app you want to interact with in the URL field; whether you’re sending data, fetching it, updating something, or deleting it. Think of this field as the ...PATCH Method in Webhook Block
Do you need to update just one or two pieces of information in another system, such as changing a ticket’s priority or updating a user’s phone number, without touching anything else? Use the PATCH method in your Webhook block to make precise, partial ...Multipath in Webhook Block
Not every API call ends the same way. When your chatbot interacts with external systems using a Webhook block, you often expect different types of responses. Some API calls are successful, like when the system finds a customer’s data, while others ...
New to Zoho LandingPage?
Zoho LandingPage Resources