Creating a Web Hook
To create a Web Hook, launch your form in the Form Designer and select Web Hooks from the Post-Processing menu, or right-click on a form in your dashboard and choose Form Tools > Web Hooks.
The following setting scan be configured via the Web Hook Wizard:
| Property | Description |
|---|---|
| Hook Name | Enter a name for the Hook |
| Hook Type | Choose the type of hook to create. The Type corresponds to when the hook runs. Hooks can run Before the form is displayed (Before Show), after it is submitted but before it is recorded in the database (Before Submit) or after the form submission is recorded (After Submit). See Web Hooks Overview: Types of Web Hooks for more details. |
| Execution Rule | Configure a rule that must be matched before the web hook is run. Conditional logic can also be included in the web hook itself. Note, that there is no option to setup rules when Before Show mode is selected, since there are no form values available to Before Show Hooks. |
| Execute on Update | Select if the hook should run when a record is updated. This includes updates via the record details view, respondent update mode, approval mode, and via workflows. |
| Execute on Insert | Select if the hook should run when a new form submission is made. This is the most common usage. The hook will run when a new form submission is received. |
| Enable Logging | When checked the web hooks actions will be logged. You can add additional logging by writing log ('My Custom Log Message') in your JavaScript. |
| JavaScript Editor | Click the JavaScript Editor button to write the script that will run inside the Node.js framework. Learn more about the API, Syntax, and details. |
You can create multiple Before Submit & After Submit Hooks, but can only have one Before Show Hook per form.
Learn More:
Have more questions? Submit a request
Please sign in to leave a comment.
0 Comments