GuidesIntegrating with Wicket
Role Restriction
How to control synchronization based on roles
Role restriction allows you to control which Wicket members are synchronized with external platforms based on their roles.
Overview
Not all members should be synced to every platform. Role restriction enables you to:
- Sync only active members
- Limit sync to specific membership tiers
- Exclude certain roles from integration
- Control access to premium platforms
Use Cases
Member-Only Platforms
Sync only people with active memberships:
- Learning management systems
- Member directories
- Premium content platforms
Tiered Access
Different membership levels get different platform access:
- Basic members: Newsletter platform only
- Professional members: LMS and community forum
- Premium members: All platforms including events
Role-Based Sync
Specific roles determine platform access:
- Board members: Governance platform
- Committee chairs: Project management tools
- Volunteers: Event management system
Implementation Approaches
Pre-Sync Filtering
Filter records before syncing to external platform:
# Pseudocode
members = get_members_to_sync()
filtered = members.filter(member =>
member.has_active_membership() &&
member.roles.includes('premium')
)
sync_to_platform(filtered)Webhook Filtering
When processing webhooks, check membership status:
- Receive person update webhook
- Check person's membership status and roles
- If eligible, sync to platform
- If not eligible, skip or remove from platform
Query-Based Filtering
Use Wicket MDP API filters to retrieve only eligible members:
GET /people?filter[membership_status]=active&filter[role]=premiumConfiguration Options
By Membership Status
| Status | Sync Behavior |
|---|---|
| Active | Include in sync |
| Expired | Remove or archive |
| Pending | Optionally include |
| Cancelled | Exclude |
By Role Type
| Role | Platform Access |
|---|---|
| Member | Core platforms |
| Staff | Internal tools |
| Admin | All platforms |
| Guest | Public platforms only |
By Membership Tier
Configure which tiers sync to which platforms:
| Tier | Platforms |
|---|---|
| Free | Newsletter only |
| Basic | Newsletter + Community |
| Professional | All except premium events |
| Enterprise | All platforms |
Handling Status Changes
When membership status changes:
Upgrade Path
- Member upgrades to higher tier
- Detect role/status change
- Add to newly eligible platforms
- Create service identities
Downgrade Path
- Member downgrades or expires
- Detect status change
- Remove from restricted platforms
- Optionally archive service identities
Best Practices
- Clear criteria: Document which roles have access to which platforms
- Graceful removal: Archive rather than delete when access is revoked
- Audit trail: Log sync decisions for compliance
- User communication: Notify members of platform access changes
- Regular review: Periodically verify sync criteria are current