Introduction to Webhooks
Webhooks connect your forms to external systems, including AI services, in real time and deliver results directly into the workflow, without requiring users to leave the app.
Available on the Elite tier:
Contents
What is a Webhook?
A Webhook fires when a user answers the required parameter questions
A parameter question is any question defined in your form that's also used to provide values to an On-Demand Data Source or a Webhook query., calls an external REST API, and returns the result directly into the form. Use a Webhook to pull data on a specific record, perform calculations, trigger actions in an external system, or call an AI service.
What are my Webhook response usage options?
Choose the right Webhook configuration based on what you need to do with the response:
| Type | What it does | When to use it |
|---|---|---|
| Info Webhook | Sends parameters and displays the response as read-only in the form. Runs automatically or manually. | The technician only needs to view reference information. |
| Routing Webhook | Sends parameters, receives a response, and routes values into other form questions. Runs manually. | The response should update answers or drive form logic. |
Note:If the form requires tabular data, for example, to populate a dropdown or list of options, use a Data Source Data sources, also known as "Lookups", are external sources of data that you upload or connect to TrueContext. You can reference this data in a form to populate answers or answer options. Data sources save typing, reduce errors, and make it easy to provide mobile users with only the relevant, most current data.
instead.
Info:For guidance on choosing between Standard Data Sources Data sources, also known as "Lookups", are external sources of data that you upload or connect to TrueContext. You can reference this data in a form to populate answers or answer options. Data sources save typing, reduce errors, and make it easy to provide mobile users with only the relevant, most current data., On-Demand Data Sources,
and Webhooks, see the On-Demand
Features Overview.
How does a Webhook work?
-
A form designer configures a FormSpace
FormSpaces are where forms are stored and organized in the TrueContext Web Portal. A TrueContext Team may have multiple FormSpaces, depending on their needs. Admins can set FormSpace permissions to control which users have access to the forms in that FormSpace.-level Webhook, adds a Webhook question to a form, and maps parameter questions to the required inputs. -
The Webhook runs automatically when all parameter questions are answered, or when the user selects Run Action.
-
The Webhook question stores the response as the answer value, displays it in the form, and, if routing is configured, saves specific parts of the response as the answer to other form questions. If confirmation is required, the user is prompted before values are applied.
-
The submission includes the Webhook response and any routed answers. Reviewers see them alongside other responses in the web portal and documents.
-
The form can use the response for info only, for routing, or for both usages combined.
When should I use a Webhook?
Use a Webhook when you need to retrieve or act on a single data object during a form submission. Common use cases include:
-
Looking up a specific record in an external system
-
Performing a calculation and returning the result
-
Calling an AI service for a risk score or recommendation
-
Triggering an action in an external system
What are the constraints for Webhooks?
- Each call sends a single synchronous request and receives a single response in the same session; asynchronous callbacks aren't supported.
- Webhook responses can’t contain binary or executable content.
- Requests and responses are limited to 32,000 characters; if the limit is exceeded, the Webhook fails.
- Each Webhook requires at least one parameter and supports up to 10.
- Webhooks aren’t available in Customer Feedback Forms Customer Feedback Forms are browser-based, can be used on any platform, and are available to customers and third parties by means of a URL link. They don’t require an app download or a user login..
- Each form can reference up to five unique Webhooks.