Why it matters
Data settings control how external and internal data is structured in Whippy. This allows Whippy to align with your existing systems, support personalization, and power segmentation, automations, and campaigns.
Key Concepts
Contacts: The base unit for all messaging in Whippy. Contacts represent individual people and include core metadata such as name, phone, email, tags, language, and timestamps.
Custom Objects: Custom data structures tied to a contact, such as job orders, appointments, or locations. These objects usually reflect data from external systems.
Custom Properties: Individual fields within a custom object, such as job ID, candidate number, or job type.
Segments: Dynamic groups of contacts that update automatically based on filters like tags, custom fields, or object data.
Lists: Static groups of contacts that only change when manually updated or reuploaded.
Channel Mappings: Rules that map custom data values to specific messaging channels.
Step-by-Step: Access Data Settings
Click the gear icon in the left navigation.
Open Settings.
Select Organisation.
Click Data.
Step-by-Step: Manage Custom Data Objects
Open the Custom Data tab.
Review existing custom objects using search, filter, or sort.
Click Add object to define a new custom object.
Enter an object name.
Click Create.
Note: Custom objects are typically created and populated programmatically through the Sync app or the public API. Objects cannot be manually populated with records through the UI.
Step-by-Step: Edit a Custom Object
Select a custom object from the list.
Click the More options menu.
Select Edit object.
Update the object name or configuration.
Click Save.
Step-by-Step: Manage Custom Properties
Open a custom object.
Click Add new property.
Enter the property name.
Select a property type (text, number, float, boolean, date, list, or map).
Set default value if required.
Enable Required or Search visibility if needed.
Click Update.
Step-by-Step: Manage Object Associations
Open a custom object in edit mode.
Add a source custom property.
Select a target Whippy resource.
Select a target Whippy property.
Enter a target property prefix if needed.
Choose an association type (one-to-one, one-to-many, many-to-one, or many-to-many).
Click Add Whippy association.
Click Save to apply changes.
Step-by-Step: Manage Channel Mappings
Open the Channel Mappings tab.
Click Add channel mapping.
Enter a channel mapping name.
Select the custom data object.
Select the custom property.
Enter or select the value.
Select the channel ID.
Save the mapping.
Tips and Best Practices
Keep custom objects aligned with your external system data model.
Use clear, descriptive names for objects and properties.
Limit required properties to fields that are always present.
Review search visibility to keep data pages usable.
Use segments for dynamic targeting and lists for one-time sends.
Troubleshooting
Issue | Possible Cause | Fix |
Custom object has no data | Object not populated via Sync app or API | Confirm integration or API setup |
Cannot add records manually | UI does not support record creation | Use Sync app or public API |
Channel mapping not working | Incorrect property or value selected | Review mapping configuration |
Missing fields from ATS | Integration not syncing fields | Contact Customer Success |
If you experience any issues or are unsure how your data settings should be configured for your integration, contact Customer Success for assistance.
