By integrating the mobile platform with Heartland POS, new consumers can easily be converted into mobile subscribers and more. The integration is purely one-directional, and only process actions FROM Heartland POS >> TO the Mobile Platform. Follow the steps below to activate an integration that will OPTIN CONTACTS, UPDATE CONTACTS, and process KIOSK CHECK-INS.
Note: The integration options require certain features to be present and active within the account on the mobile platform (ex: campaigns and kiosks). For guidance on creating these features, please see the related articles in the Knowledge Base.
Validate Connection to Heartland POS
A connection between the mobile platform and the desired Heartland POS account must be established. This is performed by inserting an API token, created within the desired Heartland POS account, into the account's integration settings on the mobile platform. Follow the steps below to create the API token and insert it to the desired account's integration settings.
Step 1. Log in to the Heartland Retail dashboard.
Step 2. Click the name/avatar in the top-right corner and select “My Account” from the dropdown
Step 4. Add a description for the token (e.g., “Inventory sync app,” “Reporting tool”) and click “Generate token”.
Step 5. << IMPORTANT >> Copy the API token immediately - this is the only chance; it won’t be shown again. Once copied, click “Done” to finalize.
Step 6. Sign In to the desired account on the mobile platform. Then click Messaging, click Gateway API, then click the prompt to access the system's v2 APIs.
Step 7. Click the API Integration Tab and use the drop-down menu provided to select Heartland POS, then click the NEXT button.
Step 8. In the space provided insert the Heartland POS API key and click SAVE.
The system will authenticate the API key and display "Validated" when successful.
Note: Validation only needs to be done once to confirm a connection between Heartland POS and the account on the mobile platform.
Activate Integration Options
Contact Opt-In -
When a new customer is created in Heartland POS, the mobile number will be linked to the selected mobile campaign.
Note: The newly created contacts will not be sent a welcome message from the system. As a matter of compliance, these contacts will need to be sent an invite from the mobile platform. Activate TCPA Always On, or, configure Target Lists and Trigger Messages for the account to automate sending the newly created contacts an invite to receive ongoing messages.
Contact Update -
When a contact's information (ex: First Name, Last Name, Email) is updated in Heartland POS, the contact will be updated on the mobile platform. If the mobile has opted out of messaging, their details will be updated, but they will remain opted-out.
Note: The updated profile fields include First Name, Last Name, Email, and Address, City, State, and Zip.
Kiosk Check-in -
When a new transaction is tendered in Heartland POS, the contact information will be processed through the selected kiosk and button on the mobile platform.
What occurs when the information is processed through the kiosk is no different than if the consumer were to use a physical kiosk, and is specific to the button selected.
- Opt-in 1 & Opt-in 2 - If either button is selected, the contact will be opted-in to the mobile campaign and will be sent the campaign's opt-in filter, and, or, welcome message. To prevent the welcome message from sending more than once per contact, please use the campaign's Opt-In Management tab and activate the "Contest (Restrict Multiple Entries)" option.
- Loyalty - If this button is selected, and the contact is newly opted-in to the campaign, they will be sent the campaign's opt-in filter, and, or, a welcome message. All contacts processed through this button will receive 1 check-in towards the campaign's loyalty program. If the submission results in a check-in that earns the contact a reward, they will be sent the corresponding loyalty reward message.
- Loyalty + Data - If this button is selected, and the contact is newly opted-in to the campaign, they will be sent the campaign's opt-in filter, and, or, a welcome message. This option cannot be used when the button is set to "DATA CAPTURE." The current integration ONLY processes through this button when configured for "QUANTITY SELECTOR." All contacts processed through this button will receive a check-in to the loyalty program representing their rounded purchase amount (ex: $9.75 spent = 10 check-ins). If the submission results in a check-in that earns the contact a reward, they will be sent the corresponding loyalty reward message.