Empowers business users to create and deploy digital forms for enterprise and government organisations as web and native apps, while allowing developers to customise, extend, or harness the forms through their own custom apps. Connect your forms with Power Automate to allow easy submission of your form data into your backend systems or databases without the need to write complex integration code.
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
GetFormSubmissionMetaWebhookTrigger (integer webhookSubscriptionId) |
Allows for Form Submission Meta Webhook to be retrieved |
DeleteFormSubmissionMetaWebhookTrigger (integer webhookSubscriptionId) |
Allows for Form Submission Meta Webhook to be deleted |
Retrieve Form Submission Data |
Name |
Summary |
Triggers when a Form submission occurs |
Name |
Summary |
|
|
|
|
FormSubmissionMetaWebhookTriggerParameterRequest body of webhook |
|
Summary: Allows for Form Submission Meta Webhook to be retrieved
Description: Retrieve a Form Submission Meta Webhook
Syntax:
CivicPlusTransform.GetFormSubmissionMetaWebhookTrigger (integer webhookSubscriptionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookSubscriptionId |
integer
|
ID of the Hook being retrieved |
True |
Returns:
Type:FormSubmissionMetaWebhook
Summary: Allows for Form Submission Meta Webhook to be deleted
Description: Deletes a Form Submission Meta Webhook
Syntax:
CivicPlusTransform.DeleteFormSubmissionMetaWebhookTrigger (integer webhookSubscriptionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookSubscriptionId |
integer
|
ID of the Hook being deleted |
True |
Returns:
Summary: Retrieve Form Submission Data
Description: Allows for Form Submission data to be retrieved
Syntax:
CivicPlusTransform.GetFormSubmissionData (integer formId, string submissionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
formId |
integer (Form Id) |
ID of the form being retrieved |
True |
|
submissionId |
string (Submission Id) |
ID of the form submission being retrieved |
True |
Returns:
Type:FormSubmissionData
Summary: Triggers when a Form submission occurs
Description: Creates a Form Submission Meta Webhook
Syntax:
CivicPlusTransform.FormSubmissionMetaWebhookTrigger (FormSubmissionMetaWebhookTriggerParameterRequest body of webhook Request body of webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of webhook |
FormSubmissionMetaWebhookTriggerParameterRequest body of webhook
|
|
True |
Returns:
Type:FormSubmissionMetaWebhook
Summary:
Description:
Properties:
Name |
Type |
Summary |
definition |
|
|
submission |
Submission Data |
|
submissionTimestamp |
string(date-time) Submission Timestamp |
|
user |
|
|
device |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Form Name |
|
description |
string Form Description |
|
Summary: Submission Data
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
providerUserId |
string Submitted By: User Id |
|
firstName |
string Submitted By: First Name |
|
lastName |
string Submitted By: Last Name |
|
fullName |
string Submitted By: Full Name |
|
|
string Submitted By: Email Address |
|
picture |
string Submitted By: Image URL |
|
role |
string Submitted By: Role |
|
userId |
string Submitted By: Internal User Id |
|
providerType |
string Submitted By: Provider Type |
|
supervisor |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
providerUserId |
string Submitted By: Supervisor User Id |
|
fullName |
string Submitted By: Supervisor Full Name |
|
|
string Submitted By: Supervisor Email Address |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string Device: Type (CORDOVA, BROWSER, PWA) |
|
cordova |
string Device: Cordova Version |
|
model |
string Device: Model |
|
platform |
string Device: Platform |
|
uuid |
string Device: Universally Unique Identifier |
|
version |
string Device: Operating System Version |
|
manufacturer |
string Device: Manufacturer |
|
isVirtual |
boolean Device: Was a Simulator |
|
serial |
string Device: Hardware Serial Number |
|
appCodeName |
string Device: Browser Code |
|
appName |
string Device: Browser Name |
|
appVersion |
string Device: Browser Version |
|
cookieEnabled |
boolean Device: Were Cookies Enabled |
|
hardwareConcurrency |
number Device: Hardware Concurrency |
|
language |
string Device: Preferred Language |
|
maxTouchPoints |
number Device: Maximum Supported Touch Points |
|
userAgent |
string Device: User Agent |
|
vendor |
string Device: Browser Vendor |
|
vendorSub |
string Device: Browser Vendor Version |
|
webdriver |
boolean Device: Was Controlled by Automation |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
|
keyId |
string
|
|
organisationId |
string
|
|
id |
integer
|
|
createdAt |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
callbackUrl |
string
|
Callback URL to push data to the Form Submission Meta Webhook Trigger |