FireForm SMS Consent Integration

Importing a Prebuilt Form and Connecting to Convergence Cloud

This document explains how to import the prebuilt SMS consent form into FireForm, register the integration with Convergence Cloud, and configure the integration rule using a raw JSON payload.

All web forms used to obtain consent will use the Double Opt-In method by default.

This is the recommended setup method as it minimizes manual configuration and reduces integration errors.

Note: All web forms used to obtain consent will use the Double Opt-In method by default.

Before you begin

You should have:

• Access to FireForm

• Access to Salesforce CRM

• This FireForm import file. Click to download - fireform-consent-import.txt

• The provided raw JSON payload

• The Consent Package ID from the Enterprise CRM team

Importing the FireForm

1. Log in to your Fireform tenant.

2. Click on Tools, then Forms.

3. Click on the Import Form button.

4. Fill out the following information:
   1. Name: What you want your form to be titled
   2. Form Code: What you want the URL for your form to end in. (Example: https://iucrm-fireform.eas.iu.edu/online/form/index/ConsentForm - ConsentForm would be the Form Code)
   3. Page Section: Choose General
   4. Sort Order: Keep this as 1
   5. Workflow: Choose Default Workflow

5. Click on the Select a File button and select fireform-consent-import.txt for upload.

6. Click Save.

The imported form already includes:

• Consent Information section

• First Name field

• Last Name field

• Email field

• Mobile Number field

• Required SMS Agreement checkbox

• Consent disclaimer language

The imported form is already configured with the correct field order and required field settings.

Reviewing the imported form

1. Once the import has finished, find your newly created form in the list of forms and click on its name to open it.
2. Click Edit.
3. Change Status to Active.
4. You can click Form Options to expand that area and change settings, such as "Require IU Login" if you want your form to be behind IU Login authentication.
5. Click the Update button in the bottom right.
6. Click the link to the online form and your form will open in a new browser tab.
7. Confirm that your form contains the following fields:

The form should appear similar to:

Consent Information

First Name
Last Name
Email
Mobile Number

☐ Yes, I want to receive Indiana University SMS Messages (*required)

The SMS Agreement checkbox must remain required for compliance purposes.

Registering the integration in Convergence Cloud

1. Log into the Enterprise CRM.

2. Click on the the App Launcher. (Nine dots near the upper left corner)

3. Click on IU Convergence Cloud.

4. Click on Form Handler.

5. In the blank below the API Endpoint, paste your form URL from Fireform and paste it. 

6. Click + Add URL.

7. Confirm that an entry for your form shows up in the list. It will show the form URL and then immediately to the right of that a string of characters that you will use as an integration password. Remember where to find these credentials. They will be used inside FireForm.

Creating the FireForm integration rule

1. Return to Fireform and open your form. (this is not the link to your form, but the form configuration area within Fireform itself)

2. Click on Integration.

3. Click Add Integration.
4. Fill in the following values:
   1. State: New
   2. On Success Move to Routing Step: 1 - New
   3. On Failure Move to Routing Step: 1 - New
   4. Leave On Failure Skip Retry unchecked
   5. Number of retry attempts - 2
5. Click Save.
6. Click Add Integration Rule.
7. Configure the rule with the following values:
   1. Name: Modern Campus Consent (you may customize this name to fit your needs)
   2. Rule Order: 10
   3. Status: Active
   4. HTTP Method: POST
   5. Endpoint URL: https://iu-convergence-cloud.herokuapp.com/api/form
   6. Authorization Type: Basic Auth
   7. Username: Insert your form URL. (e.g., https://iucrm-fireform.eas.iu.edu/online/form/index/ConsentForm)
   8. Password: The password generated by Convergence Cloud.
   9. Data Format: Send Raw Data
   10. Send Raw Data: 
       • {
"sms_consent_event__c.event_source__c":"Web Form",
"sms_consent_event__c.event_type__c":"Opt-in",
"sms_consent_event__c.event_date__c":"{FormEntry.CreatedDatetime}",
"SMS_Consent_Event__c.sms_consent_package__c":"REPLACE_WITH_CONSENT_PACKAGE_ID",
"Contact.FirstName":"{Element_1}",
"Contact.LastName":"{Element_2}",
"Contact.Email":"{Element_3}",
"Contact.MobilePhone":"{Element_4}"
}
8. Find "REPLACE_WITH_CONSENT_PACKAGE_ID" and replace it with the Consent Package ID provided by the Enterprise CRM team, leaving the quotes in place. (e.g., a5s01234567Sg18IBC)
9. Click Save.

You should now have a working form for collecting consent from contacts that you wish to text with Modern Campus. 

Understanding the JSON raw data fields

Consent language

The imported form already contains the approved consent disclaimer language.

The agreement section should state:

By providing your number and checking the box above, you are agreeing to subscribe and receive informational text messages from Indiana University. Message and data rates may apply. Carriers are not liable for delayed or undelivered messages. Message frequency varies per user. Text HELP or visit Contact IU for assistance. Text STOP to opt out at any time. View Terms of Service and Privacy Policy.

The SMS Agreement checkbox should never be removed or made optional.

Troubleshooting

Form submits successfully but consent creation fails

Verify:

• Endpoint URL is correct

• Username/password are correct

• Integration Rule is Active

Contact fields are blank

Verify the imported form still contains:

Consent event not created

Verify:

• Consent Package ID is valid

• Endpoint URL is correct

• Authentication credentials are valid