Syncing People from Wicket to Your Platform
How to push member data from Wicket to external platforms
This guide covers how to synchronize person records from Wicket to external platforms, ensuring your integrated systems have up-to-date member information.
Overview
Outbound sync pushes Wicket member data to external platforms. This typically involves:
- Detecting changes in Wicket (new members, updates, deletions)
- Transforming data to the target platform's format
- Creating or updating records on the external platform
- Storing the service identity link in Wicket
Sync Triggers
Webhook-Based (Push)
Configure Wicket to send webhooks when person records change:
person.created- New member addedperson.updated- Member information changedperson.deleted- Member removedmembership.created- New membership addedmembership.updated- Membership changed
Scheduled Sync (Pull)
For platforms that don't support webhooks or need periodic full syncs:
- Full sync: Compare all records and update differences
- Incremental sync: Process records changed since last sync
Data Mapping
Map Wicket person fields to your platform's user schema:
| Wicket Field | Common External Fields |
|---|---|
given_name | first_name, firstName |
family_name | last_name, lastName |
primary_email | email, email_address |
uuid | external_id, wicket_id |
membership_status | status, member_type |
Creating Service Identities
When you create a record on the external platform, store the relationship:
POST /service_identities
{
"person_id": "wicket-person-uuid",
"service_id": "your-service-uuid",
"external_id": "platform-user-id",
"namespace": "users"
}This link enables:
- Future updates to target the correct record
- Bidirectional sync without duplicates
- Activity tracking via touchpoints
Handling Updates
When a Wicket person is updated:
- Look up the service identity for the person and service
- If found, update the existing external record
- If not found, create a new record and service identity
Handling Deletions
Options for handling deleted Wicket members:
- Archive: Mark the external record as inactive
- Delete: Remove the record from the external platform
- Ignore: Leave the external record unchanged
Error Handling
Common issues and solutions:
| Error | Cause | Solution |
|---|---|---|
| 404 Not Found | External record deleted | Remove stale service identity |
| 409 Conflict | Duplicate record | Find and link existing record |
| 429 Rate Limited | Too many requests | Implement backoff strategy |
Best Practices
- Batch operations: Group multiple updates when possible
- Idempotency: Ensure re-running sync doesn't create duplicates
- Logging: Track all sync operations for debugging
- Validation: Verify required fields before sending
- Rate limiting: Respect external platform's API limits