TransForm onSubmit Event BuilderCall a Webhook
Description
Sends data submitted in a Form to a web service.
Discussion
POST data that was submitted to an end point. Data is submitted as a "name - value" pair. The name is defined by the Variable name property. The value the submitted Form data in JSON format.
Configuring the Call Webhook Action
The following properties are used to configure the Call webhook action.
- Property
- Description
- URL
The webhook URL where the Form data is sent.
- Headers
Optional list of headers to include in the REST call. Headers are defined as a list of "name: value" pairs. For example:
Authorization: bearer mytoken Content-Type: application/json
There are specific headers you can include to change how data is posted to the web service:
- Header
- Description
- Content‑Type: application/json
Form data is submitted as JSON without the variable name prefix.
- signatures: s3
Signatures in the Form should be converted to images (images will be uploaded to Amazon S3). The web service will receive images instead of SVG for signature fields in the Form.
- Form Ids
The Forms the Call Webhook action applies to. Forms are specified as a comma-delimited list of Form Type Ids. For example:
Form1,Gemba,Solar
You can use the "*" wildcard character when defining the Form Types to include. For example, to include all Form Types that start with "inspection" or "installation", you would enter:
inspection*,installation*
To specify that the action applies to all form types, leave Form Ids blank or enter the following value:
*
- Variable name
The name of the variable for the posted data. The posted data variable will user the name specified in Variable name. The value will be the submitted Form data formatted as a JSON string.
If desired, you can submit the Form data as JSON instead of as a variable value by adding the Content-Type header to Headers. This ignores the Variable name and posts the Form data JSON directly to the web service:
Content-Type: application/json