📋 Slate Integration Client Task Tracker
Before you begin, we recommend using our Slate Integration Client Task Tracker:
The tracker is optional, but highly recommended.
It gives you a checklist of the steps required to configure your Slate integration and allows you to keep track of what has already been completed.
As you work through this tracker:
Mark each task as you complete it.
Add any relevant notes or questions.
Use the tracker to identify any outstanding steps before testing begins.
If you choose to use the tracker, please share it with Unibuddy Support when you send us your Slate Service Account details in Part 2.
This gives both your team and ours visibility of the setup and can make it much easier to identify a missing step if something does not work as expected.
Before you begin
Before setting up the Slate integration, please make sure:
Your main Unibuddy Chat Platform has been embedded on your university website.
You have shared the URL where the Chat Platform is embedded with your Unibuddy Customer Success Manager. The URL must be live and publicly accessible, not a test or staging URL.
At least one prospect has registered with your Unibuddy platform.
You will need appropriate Slate permissions to configure Source Formats. You'll create your Slate Service Account in Part 2.
Step 1 — Create your Source Format
In Slate:
Go to Database.
Navigate to Source Formats.
Create a new Source Format.
Give the Source Format a clear name, for example: Unibuddy
Configure the Source Format with the following settings:
Status: Active
Format: JSON
Remap As Of Date: Use the current date.
This field tells Slate how far back to look into the imported data to make them available for remapping. Since you're creating a brand new Source Format, it's recommended that you use the current date.
Make sure SFTP access is turned OFF.
What about Remap Active?
Do not activate Remapping yet. You'll configure your mappings and activate Remapping in Part 2, after your sample data has arrived.
Step 2 — Add the Unibuddy Format Definition
Next, add the Unibuddy Format Definition to your Source Format.
The Format Definition tells Slate which fields it should expect within the JSON sent by Unibuddy.
<layout type="json" node="/">
<f id="email" s="email" />
<f id="first_name" s="first_name" />
<f id="last_name" s="last_name" />
<f id="accept_marketing" s="accept_marketing" />
<f id="active" s="active" />
<f id="applicant_id" s="id" />
<f id="sign_up_location" s="sign_up_location" />
<f id="date_of_entry" s="date_of_entry" />
<f id="degree_level" s="degree_level" />
<f id="conversation_summary" s="conversation_summary" />
<f id="blocked_by_university" s="blocked_by_university" />
<f id="degrees_interested_1_name" s="degrees_interested[0]/name" />
<f id="degrees_interested_2_name" s="degrees_interested[1]/name" />
<f id="degrees_interested_3_name" s="degrees_interested[2]/name" />
<f id="degrees_interested_4_name" s="degrees_interested[3]/name" />
<f id="degrees_interested_5_name" s="degrees_interested[4]/name" />
<f id="country_code" s="country/code" />
<f id="country_name" s="country/name" />
<f id="domestic_region_name" s="domestic_region/name" />
<f id="domestic_region_country_code" s="domestic_region/country/code" />
<f id="domestic_region_country_name" s="domestic_region/country/name" />
<f id="decision_stage_name" s="decision_stage/decision_stage_name" />
<f id="decision_stage_date" s="decision_stage/decision_stage_date" />
<f id="decision_stage_reason" s="decision_stage/decision_stage_reason" />
<f id="confidence_in_choosing" s="confidence_in_choosing" />
<f id="confidence_in_choosing_driver" s="confidence_in_choosing_driver" />
<f id="signup_source_type" s="signup_source/type" />
<f id="signup_source_created" s="signup_source/created" />
<f id="source_tracking_params_medium" s="source_tracking_params/ub_medium" />
<f id="source_tracking_params_source" s="source_tracking_params/ub_source" />
<f id="source_tracking_params_campaign" s="source_tracking_params/ub_campaign" />
<f id="source_tracking_params_content" s="source_tracking_params/ub_content" />
<f id="YOUR_CUSTOM_FIELD" s="YOUR_CUSTOM_FIELD" />
</layout>
Important – Unibuddy applicant ID:
The applicant_id field is the unique ID Unibuddy sends for each prospect. Keep this field in your Format Definition.
In Part 2, you will map it to a unique person field in Slate for the Unibuddy ID.
More information can be found here.
Custom fields
If you have additional Unibuddy custom fields that you would like to receive in Slate, add them at the end of the Format Definition using the same structure:
<f id="YOUR_CUSTOM_FIELD" s="YOUR_CUSTOM_FIELD" />
Replace YOUR_CUSTOM_FIELD with the custom field name you want to receive. Replace spaces with underscores (_) and remove any special characters.
Custom fields need to be explicitly included in the Format Definition before they can be mapped in Slate.
PLEASE NOTE:
Each custom field should have a unique name. If two custom fields use the same name, one value may overwrite the other.
Custom field names should not contain special characters such as
?or!. Remove these from the field name in your Admin Dashboard before configuring the field in Slate.Replace spaces with underscores (
_) in the Format Definition -For example, Why did you choose our university becomes:
<f id="why_did_you_choose_our_university" s="why_did_you_choose_our_university" />
Are you using Unibuddy Community?
If you would also like Community join interactions to appear on a prospect's activity timeline in Slate, there are some additional fields and configuration steps you'll need to complete.
Follow the instructions here:
Next step
Your Source Format is now ready. Continue to Slate Setup Part 2: Syncing with Unibuddy to create your Slate Service Account, connect the integration and begin testing.