Pre-release — content may change.

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:

  1. Receive person update webhook
  2. Check person's membership status and roles
  3. If eligible, sync to platform
  4. 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]=premium

Configuration Options

By Membership Status

StatusSync Behavior
ActiveInclude in sync
ExpiredRemove or archive
PendingOptionally include
CancelledExclude

By Role Type

RolePlatform Access
MemberCore platforms
StaffInternal tools
AdminAll platforms
GuestPublic platforms only

By Membership Tier

Configure which tiers sync to which platforms:

TierPlatforms
FreeNewsletter only
BasicNewsletter + Community
ProfessionalAll except premium events
EnterpriseAll platforms

Handling Status Changes

When membership status changes:

Upgrade Path

  1. Member upgrades to higher tier
  2. Detect role/status change
  3. Add to newly eligible platforms
  4. Create service identities

Downgrade Path

  1. Member downgrades or expires
  2. Detect status change
  3. Remove from restricted platforms
  4. Optionally archive service identities

Best Practices

  1. Clear criteria: Document which roles have access to which platforms
  2. Graceful removal: Archive rather than delete when access is revoked
  3. Audit trail: Log sync decisions for compliance
  4. User communication: Notify members of platform access changes
  5. Regular review: Periodically verify sync criteria are current

On this page