External Systems Integration

cidaas integrates with external systems to provide a complete identity and access management solution. This guide covers integration patterns, data flows, and system ownership.

Integration Patterns

Webhooks (Event-Driven)

cidaas sends webhook events to external systems when user actions occur.

When to Use: Real-time synchronization, immediate notifications

Flow: User action → cidaas → Webhook event → External system

API-Based

Your application calls cidaas APIs to retrieve or update user data.

When to Use: On-demand data access, user-initiated actions

Flow: Application → cidaas API → Get/Update user data

Batch Synchronization

Periodic batch jobs synchronize data between systems.

When to Use: Large data volumes, non-critical timing

System Ownership

cidaas (Master Identity):

• User identity and authentication credentials
• Basic profile data (name, email, phone)
• Verification status

External Systems (Application Data):

• Business-specific data (orders, preferences)
• Application state and historical records

Data Flow

User Registration

User → cidaas → Webhook: USER_CREATED → CRM, Marketing Tools

Data Transferred: sub, email, name, createdTime, custom fields

User Profile Update

User → cidaas → Webhook: USER_UPDATED → CRM, Reporting

Data Transferred: Updated fields, timestamp, sub

User Login

User → cidaas → ID Token → Application Backend → Analytics

Data Transferred: User identifier, email, name (from ID token), login timestamp

Common Integration Scenarios

CRM Integration

When Called: User registration, profile updates, deletion

Key Data:

• sub → Customer ID (primary link)
• email, given_name, family_name
• email_verified, createdTime

Webhook Events: USER_CREATED, USER_UPDATED, USER_DELETED

Marketing Tools

When Called: User registration, consent changes, profile updates

Key Data:

• sub, email, mobile_number
• customFields.newsletter_consent, locale

Webhook Events: USER_CREATED, CONSENT_ACCEPTED, CONSENT_REVOKED

Reporting/Analytics

When Called: User login, registration, actions

Key Data:

• Event type, timestamp, user identifier
• Device info, location, authentication method

Webhook Events: USER_LOGIN, USER_REGISTERED, USER_UPDATED

Key Webhook Events

Event	When	Use Case
USER_CREATED	New registration	Create records in CRM, marketing
USER_UPDATED	Profile change	Sync updates to external systems
USER_DELETED	Account deletion	Mark records inactive
USER_LOGIN	Successful login	Track activity, update last login
CONSENT_ACCEPTED	Consent accepted	Update marketing preferences

For complete webhook documentation, see Webhook Management.

Integration Checklist

• Identify external systems needing integration
• Define data ownership (cidaas = master identity)
• Map cidaas fields to external system fields
• Choose integration pattern (webhook, API, batch)
• Configure webhook endpoints
• Test webhook delivery and processing
• Set up error handling and retries

Next Steps

• Learn about Webhook Management
• Review User Management Flows