Ticket Creation
Create support tickets in Zendesk, Freshdesk, Jira, or any helpdesk directly from the chat. Visitors receive their ticket number instantly.
API Form Module
Submit Chat Data to Any System
POST collected form data to any external API endpoint and display the response directly in the chat conversation. Create support tickets, submit orders, register users, check stock levels, or trigger any backend process — all from within the chat, with instant feedback to the visitor.
- No credit card
- 14-day free trial
- UK hosted
- Visual builder
What Is the API Form Module?
The API Form module takes data collected during the chat conversation and sends it as an HTTP POST request to any external API endpoint you specify. Crucially, unlike the fire-and-forget Webhook module, the API Form waits for the response and can display it directly in the chat. This two-way communication turns your chat widget into a powerful transactional interface — visitors can create records, submit forms, and receive confirmation without ever leaving the conversation.
Consider a support workflow: a visitor describes their issue, provides their email, and the API Form module instantly creates a ticket in your helpdesk system. The API responds with a ticket number, which is displayed in the chat: "Your ticket #4821 has been created. We'll respond within 2 hours." The visitor gets immediate confirmation, and your support team has a fully formed ticket ready to work on.
The module supports custom headers (for authentication), configurable request bodies (mapping collected fields to API parameters), and response field extraction (pulling specific values from the JSON response to display or use in subsequent workflow steps). It's the most powerful integration module in the workflow builder, connecting your chat directly to your backend systems.
Order Submission
Submit orders to your ecommerce backend, inventory system, or ERP. Confirm the order and estimated delivery right in the conversation.
User Registration
Register new users, create accounts, or sign visitors up for services. The API response can include login credentials or next-step instructions.
Data Lookups
Query your backend for order status, stock availability, account balances, or appointment slots. Display the live result directly in the chat.
How the API Form Module Fits Into a Workflow
The API Form module typically appears after one or more data-collection steps. First, a Collect Info node gathers the visitor's name and email. Then, additional form fields capture specific details (issue description, order number, product selection). Finally, the API Form node packages all this data into a POST request, sends it to your endpoint, and extracts the response for display.
Because the module waits for the API response, it introduces a brief pause in the conversation. A loading indicator keeps the visitor informed. Most APIs respond within a second or two, so the experience feels natural — similar to a human agent typing a response. For slower APIs, you can add a "Please wait while I process that…" Message node before the API Form to manage expectations.
Example: Automated Support Ticket Creation
A software company creates helpdesk tickets directly from the chat conversation.
START
Step-by-Step Breakdown
- Collect Info: The workflow gathers the visitor's name, email, and a description of their issue through conversational prompts.
- Processing Message: A brief message tells the visitor their ticket is being created, managing expectations during the API call.
- API Form: The module POSTs the collected data to the helpdesk API. The API responds with a JSON object containing the new ticket number and estimated response time.
- Confirmation Message: The extracted ticket number is displayed in the chat, giving the visitor immediate confirmation and a reference number for follow-up.
Best Practices & Tips
The API Form module is powerful but requires careful configuration. Follow these practices for reliable, secure integrations.
Authenticate Securely
Use API keys or bearer tokens in custom headers — never embed credentials in the URL. The workflow builder stores header values securely and they are never exposed to visitors.
Handle Errors Gracefully
Configure a fallback message for API failures. Instead of a generic error, show something helpful: "We couldn't create your ticket right now — please email support@example.com." Visitors should never see raw error codes.
Map Fields Carefully
Ensure the data collected in earlier steps matches exactly what the API expects. Field names, data types, and required parameters should all be verified before going live.
Set Expectations for Wait Times
Add a "Processing…" message before the API Form node. Even a one-second delay feels long in chat. A transitional message like "Let me look that up for you…" makes the experience feel natural.
Frequently Asked Questions
What happens if the external API is down?
If the API fails to respond or returns an error, the module displays your configured fallback message. The conversation continues normally — the visitor is never left in a broken state. You can configure the fallback to offer alternative contact methods or retry instructions.
Can I display specific fields from the API response?
Yes. The API Form module supports JSON response field extraction. You can map specific response fields (like a ticket number, order ID, or status message) to variables that are displayed in subsequent Message nodes using the {{variable}} syntax.
Is visitor data transmitted securely?
All API requests from the module are sent over HTTPS. Authentication headers and API keys are stored securely on the server side and are never exposed to the visitor's browser. We recommend that your API endpoint also uses HTTPS to ensure end-to-end encryption.
How is this different from the Webhook module?
The key difference is response handling. The Webhook module is fire-and-forget — it sends data but doesn't wait for or use the response. The API Form module sends data, waits for the response, and can display response data in the chat. Use webhooks for notifications; use API Form for transactional operations where the visitor needs confirmation.
Related Modules
The API Form module works alongside these modules to create complete data-driven chat workflows.
Turn Your Chat Into a Transactional Powerhouse
Connect your chat workflow to any API. Create tickets, submit orders, register users — and show the results instantly in the conversation. No code required.