Pre-release — content may change.

GuidesIntegrating with Wicket

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:

  1. Detecting changes in Wicket (new members, updates, deletions)
  2. Transforming data to the target platform's format
  3. Creating or updating records on the external platform
  4. 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 added
  • person.updated - Member information changed
  • person.deleted - Member removed
  • membership.created - New membership added
  • membership.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 FieldCommon External Fields
given_namefirst_name, firstName
family_namelast_name, lastName
primary_emailemail, email_address
uuidexternal_id, wicket_id
membership_statusstatus, 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:

  1. Look up the service identity for the person and service
  2. If found, update the existing external record
  3. 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:

ErrorCauseSolution
404 Not FoundExternal record deletedRemove stale service identity
409 ConflictDuplicate recordFind and link existing record
429 Rate LimitedToo many requestsImplement backoff strategy

Best Practices

  1. Batch operations: Group multiple updates when possible
  2. Idempotency: Ensure re-running sync doesn't create duplicates
  3. Logging: Track all sync operations for debugging
  4. Validation: Verify required fields before sending
  5. Rate limiting: Respect external platform's API limits

On this page