Welcome to the configuration guide for integrating Yapla with Hector. By the end of this guide, you’ll be able to automatically synchronize your Yapla members with Hector users.
Configuration
✅ Step 1: Log In to Hector
To activate the Yapla integration, log in to your Hector administrator account. Only administrators can configure integrations.
🔗 Step 2: Access Yapla Integration Settings
- In Hector, go to Settings.
- Under the Integrations section, find Yapla (in the Resource tab) and click Add.
- In the Yapla integration settings, three required fields must be completed in the Yapla integration settings. Refer to the next section to find out where to locate this information in Yapla.
🔐 Step 3: Get Your Yapla Credentials
- In Yapla, go to your Settings1.
- Under the API2 menu, you’ll find:
- Connection URL → copy this into the API URL field in Hector
- API Key → copy this into the API Key field
Important: If you generate a new API key in Yapla, you must immediately update it in Hector to maintain the integration.
- Optionally, enter a Campaign ID if you wish to sync members from a specific campaign (default is
0for the current campaign).
✅ Step 4: Validate Settings and Save
Click Validate1 in Hector to simulate a sample request to Yapla. This will verify that your credentials and configuration are valid. Ensure the integration is Enabled2 and Save and Integrate3 to save your configuration and activate the integration.
How the Integration Works
🔄 What to Expect When Syncing
Once synchronization is enabled, Hector will start syncing with Yapla based on your integration settings based on the sync frequency.
⚠️ Note: This is a one-way sync from Yapla → Hector. Hector does not send updates back to Yapla.
🕒 Sync Frequency
Hector syncs with Yapla every 15 minutes. Any new, updated, or deactivated members in Yapla will be reflected in Hector based on your integration rules.
🔁 Initial Sync Behavior
- All active members in Yapla will be retrieved.
- Existing Hector users with a matching email address will be updated. If the corresponding member is inactive in Yapla, they will also be inactivated in Hector.
- Only active Yapla members not already in Hector will be created as new users.
- If a Yapla member exists as both active and inactive with the same email address, only the active user will be synchronized.
🧱 Field Mapping on User Creation
When a Yapla member is created in Hector, the following fields are populated:
| Yapla Field | Hector Field | Notes |
|---|---|---|
| First Name | First Name | |
| Last Name | Last Name | |
| Used for matching existing users | ||
| Phone | Phone | |
| Language | Language | |
| Address | Address | |
| Zip Code | Zip/Postal Code | |
| City | City | |
| Province/State | State | |
| Country | Country | |
| Status | Enabled | Set to “Active” by default |
| Unique identifier | Autogenerated | |
| Password | A password is automatically generated for new users but is not shared. If you’d like to provide access to users, a password reset will be required. | |
| Role | Default role assigned defined under Settings → Resources → User → Options → Default Role | |
| Groups | Default groups assigned defined under Settings → Resources → User → Options → Default Group | |
| Department | Default department assigned defined under Settings → Resources → User → Options → Default Department |
🔄 Field Mapping on User Update
When a Yapla member is updated, the changes are reflected in Hector by mapping the following fields:
| Yapla Field | Hector Field | Notes |
|---|---|---|
| First Name | First Name | Updated if changed |
| Last Name | Last Name | Updated if changed |
| Updated if changed | ||
| Phone | Phone | Updated if changed |
| Language | Language | Updated if changed |
| Address | Address | Updated if changed |
| Zip Code | Zip/Postal Code | Updated if changed |
| Province/State | State | Updated if changed |
| Country | Country | Updated if changed |
| Status | Enabled | Disable user if Status is no longer Active |
⛔ Handling Inactive or Deleted Members
- If a Yapla member’s status is no longer Active, the corresponding Hector user will be marked inactive in Hector.
- Inactive Yapla members not already in Hector are not created.
- If a member is deleted in Yapla, it will stop syncing (but will not be removed from Hector).
💡 Tip: Use Hector’s user retention settings to automatically delete users who have been inactive for X time.