Pre-release — content may change.

GuidesIntegrating with Wicket

Overview

Introduction to building integrations with Wicket

This guide will help you understand the fundamentals of integrating with Wicket and get your first integration up and running.

Prerequisites

Before building an integration with Wicket, ensure you have:

  • Access to a Wicket account with API credentials
  • Understanding of REST APIs and webhooks
  • Familiarity with your target platform's API

Integration Overview

Wicket integrations enable bidirectional data synchronization between Wicket and external platforms. The key components are:

Services

A Service represents a configured integration instance. When you connect a platform to Wicket, you create a Service that stores:

  • Connection credentials
  • Sync settings and preferences
  • Platform-specific configuration

Service Identities

Service Identities link Wicket people to their corresponding accounts on external platforms. Each service identity contains:

  • The external platform's user ID
  • Optional namespace for categorization
  • Sync status and metadata

Touchpoints

Touchpoints record user activities and events from integrated platforms. They provide:

  • Activity tracking across systems
  • Engagement metrics and history
  • Audit trail of user interactions

Integration Patterns

Real-time synchronization using webhooks:

  1. External platform sends events to Wicket
  2. Wicket processes events and updates records
  3. Changes are reflected immediately

Best for: Platforms with webhook support, real-time requirements

Polling-Based

Periodic synchronization on a schedule:

  1. Wicket queries the external platform on a schedule
  2. Changes are detected and processed
  3. Updates happen at configured intervals

Best for: Platforms without webhooks, batch processing

Hybrid

Combines webhooks with periodic polling:

  1. Webhooks handle real-time events
  2. Polling catches missed events or performs full syncs
  3. Provides reliability and completeness

Next Steps

On this page