Use a Webhook

Some forms connect to external systems to retrieve information or trigger actions as you work. When a form includes a Webhook, you may notice questions that update automatically, or a Run Action button that you select to fetch data.

Available on the Elite tier:

—Digital
—Intelligent
Elite
?

Contents

Webhook purposes

Forms can include info Webhooks and routing Webhooks, or both at the same time. Each behaves differently depending on how the form is configured.

Purpose Trigger What you see Additional capability
Info Runs automatically once all required questions are answered, or manually, when you select Run Action. Response appears inline in the Webhook question as read-only.
Routing When you select Run Action. Response appears inline in the Webhook question as read-only. Routes values into other questions in the form. You're prompted to accept or decline before values are applied.

Technician experience

The form uses your answers to call an external system. Depending on how the form is configured, this can happen automatically once you've answered the required questions, or when you select Run Action. As the Webhook moves through its states, you may notice:

  • Waiting for answers: the Webhook question may appear inactive until you've answered all required questions before it. Answer those questions first.

  • Fetching: a loading indicator shows while the form contacts the external system. This usually takes a few seconds.

  • A response displayed inline: information retrieved from the external system appears in the Webhook question as read-only.

  • Other questions filled in automatically: the response may populate answers elsewhere in the form. Review these before submitting.

  • A prompt to accept or decline: some forms ask you to confirm before applying retrieved data. Review the information and select to Accept or Decline.

Steps to complete a form that contains Webhooks

Step Action
1

From your Inbox or Forms, open a form that contains a Webhook question and fill out the required fields.
2

Answer all required questions. If the Webhook is set to run automatically, it starts in the background. Otherwise, select Run Action.

The Webhook question on the mobile app showing the Run Action button.

Note:If you leave any parameter questionsClosed 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. unanswered, the app will flag them so you can provide answers and select Run Action again.

An alert on the mobile app indicating that required parameter questions must be answered before the Webhook can run.
3

Confirm the action succeeded. If configured, the response appears inline in the Webhook question as read-only.

A success indicator on the mobile app confirming the Webhook action completed.The Webhook question showing the response data displayed inline in the form.

 

If there was an error, review any error messages and select Retry once the issue is resolved.

An error message on the mobile app indicating no connection is available. An error message on the mobile app showing a Webhook request failure with a Retry option.

Review and confirm data for routing Webhooks

Step Action
4

Review the data, then select Accept or Decline.

A confirmation screen on the mobile app showing the data a routing Webhook is about to apply to the form.

  • Select Accept to save the Webhook's answer and route values into the relevant questions.

  • Select Decline to discard the data and return to the form without changes.

  • If the form doesn't require confirmation, the app saves the response and routes values automatically.

Note:If confirmation is required and you close or save the form without accepting, the app doesn't save the response. Reopen the draft and run the action again to retrieve data.
5

Review any questions the Webhook updated.

Form questions on the mobile app showing values populated by a routing Webhook.

6

Select Run Action again to refresh the response — for example, if you change a required question. This replaces the existing Webhook answer and any previously applied values.