Top

Articles in this section

Portals - Collect Marketing Data with Webhooks

Follow

Allow guests to opt in and share marketing data when they purchase wireless internet via Property Management System (PMS) or a free Service Plan. Use the Portal Editor to add fields for the data you want to collect, choose the options guests see for opting in, and then configure a webhook to send the data to your external tools.

 

 

Requirements

 

Data Capture

Configure marketing data capture forms on Pages > Purchase in the Portal Editor. If you choose the Radio Grouping layout on Pages > Select Plan, there is no Purchase page to edit, so you must configure these forms on Pages > Select Plan.

Click PMS Form or Free Form depending on which Service Plan type you are configuring. If you have both Service Plan types, you must configure both.

data-capture-forms.png

 

Fields

Add the fields you want to use for collecting data:

  1. Click Add Supported Marketing Fields to view data collection options. The available fields include:
    1. First Name (Text)
    2. Last Name (Text)
    3. Name (Text): Capture the first and last name in one field
    4. Email (Email)
    5. Apartment Number (Text): For use with residents
    6. Room Number (Text): For use with hospitality guests
    7. Zip Code (Text)
    8. City (Text)
    9. Country Code (Text)
    10. Phone Number (Text)
    11. Rewards Number (Text): For use with a rewards program
    12. Are You? (Dropdown): Capture if the resident or guest is a homeowner, member, staff, or guest
    13. Purpose of Travel (Dropdown): Capture if the purpose of travel is business or pleasure
  2. Click Add next to any field you want to use to collect data and display on the form.

Next, scroll down to Selected Fields.

The Selected Fields menu displays all of the fields that show in the form. You can edit the fields in the following ways:

  1. Click and hold a field to drag and drop it in the list.
  2. Click Desktop width to change how wide the field displays visually.
  3. Toggle Required on or off to make the field required.
  4. Click the trash can icon to remove the field from the form.

Fields with a gray trash can icon cannot be removed from the form.

After you add all of your desired fields, click the Marketing Opt In tab.

 

Marketing Opt In

Toggle Show to display the opt in options to your guests and enable sending captured data via a webhook.

  1. Toggle Show to add the marketing opt in checkbox to the form and enable sending data via a web hook.
  2. Toggle Checked by default to check the marketing opt in checkbox for guests when the page loads.
  3. Toggle Required to make the opt in decision mandatory for guests.
  4. Edit the text for the label.

 

Send External Data

Configure how you send captured data via a webhook. Your selections in this step depend on the tools you are using to capture the data.

 

  1. Add the server URL that you use for the request. The server URL must be allowlisted with the gateway and you cannot use any Cross-Origin Resource Sharing (CORS) methods.
  2. Select GET, POST, or PUT for your method. This selection depends on what your tools require.
    1. GET methods send your captured data in the URL as parameters. Update the URL text field to include the parameters of the data you are capturing in the form. For example, to send First Name, Last Name, Room Number, Marketing Opt In, and Org Number, format the URL text field like this example: 
      https://serverexample.com/?firstName={{firstName}}&lastName={{lastName}}&roomNumber={{roomNumber}}&marketingOptIn={{marketingOptIn}}&orgNumber={{orgNumber}}
    2. POST and PUT methods send your captured data in the request body. Update the Data text area field with your captured data in JSON format: 
      {
  "firstName": "{{firstName}}",
        "lastName": "{{lastName}}",
  "roomNumber": "{{roomNumber}}",
        "marketingOptIn": "{{marketingOptIn}}",
        "orgNumber": "{{orgNumber}}"
}
  3. Update the Headers text field if you want to pass any additional information.

Click Update to save the data capture settings for the form and then Save in the Portal Editor to save all changes to the portal.

Related articles