/form-submission
Data Schema{ "type": "object", "properties": { "tenant": { "type": "object", "properties": { "isLiveMode": { "type": "boolean" }, "tenantAlias": { "type": "string" } } }, "portalProject": { "type": "object", "properties": { "id": { "type": "string" } } }, "formSubmissionRecord": { "type": "object", "properties": { "formData": { "type": "object" }, "form": { "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "schema": { "type": "object" } } }, "results": { "type": "array", "items": { "type": "object" } }, "effectiveSegmentsDetails": { "type": "array", "items": { "type": "object", "properties": { "segmentOperation": { "type": "string" }, "type": { "type": "string" }, "segment": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } } } } } } } |
Example Data{ "key": "form-submission", "name": "Referral Program Opt in Form", "tenant": { "isLiveMode": false, "tenantAlias": "test_abc123" }, "portalProject": { "id": "abcdefg1234567" }, "formSubmissionRecord": { "id": "12345676890", "dateSubmitted": 1602699099284, "success": false, "formData": { "user": { "id": "12345", "accountId": "12345", "firstName": "Bob", "lastName": "Testerson", "dateSubmitted": "2020-10-15" } }, "form": { "name": "Example Form", "key": "example-form", "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dateSubmitted": { "type": "string", "format": "date-time" } } } } } }, "user": { "id": "12345", "accountId": "12345", "firstName": "Bob", "lastName": "Testerson" }, "results": [ { "formHandler": { "name": "Salesforce Integration Form Handler", "endpointUrl": "https://2547d412fb9d.ngrok.io/squatchForm", "integration": { "name": "Salesforce" } }, "result": { "results": [ { "success": false, "message": "Salesforce Integration not enabled for tenant" }, { "success": false, "message": "Salesforce insert for 'test' failed: Cannot convert undefined or null to object" } ] } } ], "effectiveSegmentsDetails": [ { "segmentOperation": "~s2", "type": "DELETE", "segment": { "key": "s2", "name": "s2" } }, { "segmentOperation": "~s1", "type": "DELETE", "segment": { "key": "s1", "name": "s1" } } ] } } |
/form-initial-data-error
Data Schema{ "type": "object", "properties": { "tenant": { "type": "object", "properties": { "isLiveMode": { "type": "boolean" }, "tenantAlias": { "type": "string" } } }, "portalProject": { "type": "object", "properties": { "id": { "type": "string" } } }, "initialData": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "inputData": { "type": "object" }, "error": { "type": "string" }, "formHandler": { "type": "object", "properties": { "name": { "type": "string" }, "endpointUrl": { "type": "string" }, "integration": { "type": "object", "properties": { "service": { "type": "string" }, "name": { "type": "string" } } } } } } } }, "form": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "object" } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } } } } } |
Example Data{ "tenant": { "isLiveMode": false, "tenantAlias": "test_abc123" }, "portalProject": { "id": "abcdefg1234567" }, "initialData": { "results": [ { "inputData": {}, "error": "Salesforce Integration not enabled for tenant", "formHandler": { "name": "Salesforce Integration Form Handler", "endpointUrl": "https://salesforce-squatch-beta.herokuapp.com/squatchForm", "integration": { "service": "eeJoByd4twtuzVos4MNQLA3brClphBY1", "name": "Salesforce" } } } ], "form": { "key": "f1", "name": null, "schema": null } }, "user": { "id": "12345", "accountId": "12345", "firstName": "Bob", "lastName": "Testerson" } } |
/failed-form-validation
Data Schema{ "type": "object", "properties": { "tenant": { "type": "object", "properties": { "isLiveMode": { "type": "boolean" }, "tenantAlias": { "type": "string" } } }, "portalProject": { "type": "object", "properties": { "id": { "type": "string" } } }, "formValidationResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "results": { "type": "array", "items": { "type": "object", "properties": { "inputData": { "type": "object" }, "error": { "type": "string" }, "formHandler": { "type": "object", "properties": { "name": { "type": "string" }, "endpointUrl": { "type": "string" }, "integration": { "type": "object", "properties": { "service": { "type": "string" }, "name": { "type": "string" } } } } } } } } } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } } } } } |
Example Data{ "tenant": { "isLiveMode": false, "tenantAlias": "test_abc123" }, "portalProject": { "id": "abcdefg1234567" }, "formValidationResult": { "success": false, "results": [ { "error": "Salesforce Integration not enabled for tenant", "formHandler": { "name": "Salesforce Integration Form Handler", "endpointUrl": "https://salesforce-squatch-beta.herokuapp.com/squatchForm", "integration": { "service": "eeJoByd4twtuzVos4MNQLA3brClphBY1", "name": "Salesforce" } } } ], "form": { "key": "f1", "name": null, "schema": null } }, "user": { "id": "12345", "accountId": "12345", "firstName": "Bob", "lastName": "Testerson" } } |
/user-email-change
Data Schema{ "type": "object", "properties": { "newEmail": { "type": "string" } } } |
Example Data{ "newEmail": "example@example.com" } |
/password-was-reset
Data Schema{ "type": "object", "properties": { "email": { "type": "string" } } } |
Example Data{ "email": "example@example.com" } |
/referral-reminder
Data Schema{ "type": "object", "properties": { "referralNumber": { "type": "number" }, "companyName": { "type": "string" }, "portalLink": { "type": "string" } } } |
Example Data{ "referralNumber": 1, "companyName": "Impact.com", "portalLink": "https://example.com" } |
/referral-reminder-second-reminder
Data Schema{ "type": "object", "properties": { "referralNumber": { "type": "number" }, "companyName": { "type": "string" }, "portalLink": { "type": "string" } } } |
Example Data{ "referralNumber": 1, "companyName": "Impact.com", "portalLink": "https://example.com" } |
/referral-weekly-report
Data Schema{ "type": "object", "properties": { "referralNumber": { "type": "number" }, "companyName": { "type": "string" }, "portalLink": { "type": "string" } } } |
Example Data{ "referralNumber": 1, "companyName": "Impact.com", "portalLink": "https://example.com" } |
/user-portal-widget-upgrade
Data Schema{ "type": "object", "properties": { "tenantAlias": { "type": "string" }, "requesterEmail": { "type": "string" }, "companyName": { "type": "string" } } } |
Example Data{ "tenantAlias": "tenant_123abc", "requesterEmail": "example@example.com", "companyName": "Impact.com" } |
/user-portal-invite
Data Schema{ "type": "object", "properties": { "projectName": { "type": "string" }, "inviterEmail": { "type": "string" }, "userRole": { "type": "string" }, "portalInviteLink": { "type": "string" } } } |
Example Data{ "projectName": "EXAMPLE", "inviterEmail": "example@example.com", "userRole": "Viewer", "portalInviteLink": "https://example.com" } |
/user-portal-added
Data Schema{ "type": "object", "properties": { "projectName": { "type": "string" }, "inviterEmail": { "type": "string" }, "loginLink": { "type": "string" } } } |
Example Data{ "projectName": "My Program", "inviterEmail": "example@example.com", "loginLink": "https://example.com" } |
/multi-auth
Data Schema{ "type": "object", "properties": { "qrCodeUrl": { "type": "string" } } } |
Example Data{ "qrCodeUrl": "https://upload.wikimedia.org/wikipedia/en/9/99/Patterson%E2%80%93Gimlin_film_frame_352.jpg" } |
/user-portal-pricing-inquiry
Data Schema{ "type": "object", "properties": { "tenantAlias": { "type": "string" }, "requesterEmail": { "type": "string" }, "requesterPhoneNumber": { "type": "string" }, "companyName": { "type": "string" } } } |
Example Data{ "tenantAlias": "test_abc123", "requesterEmail": "example@example.com", "requesterPhoneNumber": "555.555.5555", "companyName": "Impact.com" } |
/user-portal-widget-customize
Data Schema{ "type": "object", "properties": { "tenantAlias": { "type": "string" }, "requesterEmail": { "type": "string" }, "customizationRequest": { "type": "string" }, "companyName": { "type": "string" } } } |
Example Data{ "tenantAlias": "test_abc123", "requesterEmail": "example@example.com", "customizationRequest": "Please make it prettier.", "companyName": "Impact.com" } |
/reset-password
Data Schema{ "type": "object", "properties": { "resetUrl": { "type": "string" } } } |
Example Data{ "resetUrl": "https://example.com" } |
/job-complete-notification
Data Schema{ "type": "object", "properties": { "tenantAlias": { "type": "string" }, "companyName": { "type": "string" }, "downloadUrl": { "type": "string" } } } |
Example Data{ "tenantAlias": "tenant_123abc", "companyName": "Starbucks", "downloadUrl": "https://example.com", "downLoadUrlError": "ERROR", "jobType": "example job" } |
/fuel-tank-alert
Data Schema{ "type": "object", "properties": { "companyName": { "type": "string" }, "tenantAlias": { "type": "string" }, "projectId": { "type": "string" }, "codeType": { "type": "string" }, "codesRemaining": { "type": "number" }, "codesUsed": { "type": "number" }, "codeThreshold": { "type": "number" }, "uploadUrl": { "type": "string" } } } |
Example Data{ "companyName": "Impact.com", "tenantAlias": "test_abc123", "projectId": "my-project", "codeType": "discount", "codesRemaining": 1, "codesUsed": 8, "codeThreshold": 6, "uploadUrl": "https://example.com" } |
/payout-failed
Data Schema{ "type": "object", "properties": { "paymentUrl": { "type": "string" }, "paymentName": { "type": "string" }, "paymentBrandColor": { "type": "string" }, "failReason": { "type": "string" } } } |
Example Data{ "paymentUrl": "https://example.com", "paymentName": "PayPal", "paymentBrandColor": "#113984", "failReason": "due to insufficient funds" } |
/user-removed-from-project
Data Schema{ "type": "object", "properties": { "projectName": { "type": "string" } } } |
Example Data{ "projectName": "my-project" } |
/user-role-changed
Data Schema{ "type": "object", "properties": { "projectName": { "type": "string" }, "userRole": { "type": "string" } } } |
Example Data{ "projectName": "my-project", "userRole": "Viewer" } |