For AI agents: visit https://docs.capillarytech.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Home
User Documentation
API Documentation
Developer Documentation
Releases
Log In
User Documentation
Log In
Home
User Documentation
API Documentation
Developer Documentation
Releases
Payment Mode Profile
GETTING STARTED
Introduction
Accessing Capillary
CAPILLARY DATA PLATFORM
Entities Management
Customer entity
Setup Store hierarchy
Setup Transactions
Handling of rejected transactions
Setup Behavioral events
Setup Cards
Setup User Groups
Setup Customer Hierarchy
Set up Data Fields
Standard Fields
Extended Fields
Custom Fields
Create Search Filter for Entities
Use Cases
Overview
Create a Search Filter
Perform Search
FAQs
Product
Member Care (Old UI)
Register customers
Search customer/coupon
Issue & update cards
Manage ID change requests
Issue goodwill points & coupons
Retro transactions
Reallocate mobile numbers
Manage customer feedback
Member Care
Customer overview
Loyalty details
Event details
Incentive details
Communication details
Identifier change request
Points & coupons request
Retro transaction request
Customise Member Care UI using Extension
Session Logs
Group view
Advanced points breakup view
Connect+ (Old)
Overview
Getting started
Using expressions for data transformation
Configure blocks
Connect to Source
Connect to Source - Kafka
Decrypt Data
Connect to Destination
Transform Data
Join Data
CSV-To-XML-Converter
Push to S3
Encrypt Data
Schedule Trigger
Rebuild Headers / Define Headers and Transform Data
Mask Contents in a CSV
Invoke Neo Iteratively
Convert JSON to CSV/Avro Format
Convert CSV to JSON
Event Notification Block
Neo Transformer V2 Block
Connect to Destination without OAuth or S3 Pull Block
Neo Transformer Block
Data Validation Block
Explore templates
Test and control template
Add transaction template
File transfer templates
Data reconciliation template
Transaction line item merge template
PII cleanup template
Add customer template
Create or update Badges
Import Earned Badges of Customer in Bulk
CSV to XML conversion template
Coupon redeem template
Workspace & user management
Audience Reload from FTP
Onboard users to Intouch
Card update template
Fleet customers template
FTP to S3
Behavioural events ingestion
Goodwill points issue template
Earned badges for customer template
Retro transaction template
Create Rewards Template
Update Rewards Template
Force generate barcode template
Databricks job trigger template
SFTP to SFTP with Headers Definition
Ingest Kafka Stream in API
Pull Data from API
Analyse dataflow performance
Troubleshooting guide
DIY Templates
Connect+
Overview
Use Cases
Access Connect+
Introduction to the UI
Getting Started
Core Concepts
Create and Manage Connect+ Dataflows
View and Organize Dataflows
Explore Templates
Data Ingestion
Audience & Campaigns
File Transfer & Transformation
Data Management
Building Block Configuration
Trigger block
SFTP (Read) block
SFTP (Write) block
S3 (Read) block
S3 (Write) block
Kafka (Read) block
Kafka (Write) block
Transform (CSV to JSON) block
Transform (CSV to XML) block
PGP Decrypt block
PGP Encrypt block
Databricks (Validation) block
API request (http_write) block
Filter block
Filter (Hidden) block
Join files (2) block
Join files (3) block
Join files (4) block
Event notification (Read) block
Kafka Event (Write) block
Hashing (CSV) block
Databricks (Jobs) block
Iris Audience Refresh (FTP) block
JSLT block
JOLT block
Ok File block
Split block
Transform (Headers) block
SFTP (Listing) block
Cron block
aiRA Coder
Monitoring and Observability in Connect+
Troubleshooting
FAQs
Data import
Transactions profiles
Customer profiles
Inventory profiles
Org entities
Points & Slabs
Points deductions
Points expiry
Other import profiles
Payment mode import profile
Data cleanup
Target loyalty
Company
View import jobs
Fetch import details by import ID
Downloading reports (After temp DB import)
Mark stores as inactive using the data import
Event notification
Overview
Supported Events
Configure Event Notification
Manage Webhook
View Event Feed
Event Delivery and Reliability
Event schema (Payload)
Customer and User Group
Transaction
Loyalty
Loyalty Promotions and Cart Promotions
Tier
Partner Program
Incentives
Cards
Request Updates
Advanced Request Workflows
Fraud Management
Setup Fraud detection
(New) Request Workflow
Introduction
Configuring Request workflow for Customer Enrolment
Configuring Request Workflow for Badge Issuance
Configuring Request Workflow for Customer Status Change
Configuring Points Redemption Request Workflow
Configuring Goodwill Points Request Workflow
FAQ
Timezone Management
Understanding Timezone Management in the UI
FAQs
Data Import
LOYALTY+
Introduction to Loyalty+
Features of loyalty+
Types of Loyalty Programs we support
Glossary
FAQs
Loyalty guides
Retro guide
Loyalty Settings
Points Promotion
Points Rolling Expiry
Loyalty Configuration Settings
Advanced Loyalty Features
Multi-Loyalty Programs
Behavioral Loyalty
Referral Programs
Subscription program
Coalition program
Milestones (also known as Target loyalty)
Unified target/milestones
Alternate Currencies
Streaks
Overview
Configure Streaks
Connect the streak to loyalty promotions
FAQ
Loyalty+ Reporting
Loyalty Standard Report
Loyalty Sales Report
Loyalty Customer Summary Report
Points
Points Report (new)
Non Member Report
Points Redemption Custom Fields
Programs Home Page
Strategies
Tiers
Tier Upgrade
Tier Renewal & Downgrade
View tier configuration
Create Tiers and Configure Tier Upgrade Conditions
Configure Validity and Renewal Conditions
Configure Tier Downgrade
Integrations
FAQs
Points
Communication
Offers/Coupons
Advanced Settings
Trackers
Workflows
Customer Activities
Auto points conversion to reward
Actions
Rule Writing
Advanced Capping
Profiles and Attributes
Profile : Current Customer
Attributes - Customer Identity
Attributes - KPIs (Customer Points)
Attributes - Custom Field
Attributes - Slab Information
Attributes - User Segment (EI)
Attributes - KPIs (Transaction Data)
Attributes - Registration Date
Attributes - Other
Attributes - Customer status & label
Customer Subscription Status
Profile : Current Transaction
Attributes - KPI (Basket)
Attributes - Transaction Number/ID
Attributes - Custom Fields (Transaction)
Attribute - Transaction Value
Attribute - Reward Currency
Attribute - Discount
Attribute - Date
Attribute - Note
Profile : Current Line Item
Attribute - Line Item Information
Attributes - discount & discPercentage
Attributes - Line Item Properties
Profile : Current Event
Attribute - Target Based
Attribute - Loyalty Information
Attributes - Custom Field
Profile : Current Store
Attribute : Code
Profile : Current Tracker
Attributes - Tracker
Profile: Current Card
Attributes - Custom and Extended Fields
Profile: Current User Group
Attributes - Group Identity
Attributes - Group Membership
Attributes - KPIs (User Group Points)
Attributes - KPI (User Group Slab/Tier)
Loyalty Promotions
Introduction
Core Concepts
Building Blocks of Loyalty Promotions
Member Actions
Qualifying Conditions and Attributes
Operators
Brand Actions
Loyalty Promotion Limits
Create and Manage Loyalty Promotions
Create a Loyalty Promotion
Create a Broadcast Promotion
Approve or Reject a Loyalty Promotion
View a Loyalty Promotion
Duplicate a Loyalty Promotion
Edit a Loyalty Promotion
Pause and End a Loyalty Promotion
Configure Reports and Event Notifications
Configure a Loyalty Promotion Report
Configure a Loyalty Promotion Event Notification
Use Cases
FAQs
RBAC (Role-based access control)
Workflow simulation
Transaction Add
Rewards Catalog
Introduction
Reward Types
Create a Reward
Manage rewards
Rewards Catalog settings
Rewards catalog - use cases
Rewards Catalog FAQ
Badges
Introduction to Badges
Type of Badges
Getting Started
Enabling & Creating a Badge
Viewing Badges
Glossary of Terms
Configuration for Badges
Custom Field Information for Badges
Grouping and Ranking of Badges
Managing Badges
Deactivating and Activating Badges
Issuing Badges and Revoking via Loyalty Workflows and Promotions
Enrolling and Issuing Badges from Campaigns
Enrolling and Issuing Badges from Journeys
Historical Data Migration of Badges
Retro Enrolment and Issue of Badges
Badges Event Notification
Badges Reporting
Badges in Membercare
Rewards Catalog
Getting Started with Rewards Catalog
Sample Rewards Catalog for Various Verticals
Optimizing Your Rewards Budget & Catalog Inventory
Enhancing Rewards Catalog with Custom Fields
Running Attractive Discounts on Rewards Catalog
Point Redemption for Unified Multiple Loyalty Programs
Viewing Rewards Catalog Events in MemberCare
Reducing Reward Checkout Failures
Personalizing the Rewards Catalog
Redeeming Points from User Groups
Ownership concept in Rewards Catalog
Grouping and Ranking in Rewards Catalog
Point Redemption Controls for the Catalog
Different payment modes for rewards in the catalog
Reward Tracking with Status and Custom Fields in Reward Fulfillment
Rewards Event Notification
Issue Catalog Reward from Loyalty Workflow
Games
Overview
CustomerGlu games
Marvel games
User Group Loyalty
Introduction
Prerequisites
Create and Manage Groups
Configure Group Programs
Configure Points Contribution and Deduction
Configure Group Tier Synchronisation
Use Cases
Limitations
Reports for User Groups
Frequenty Asked Questions
ENGAGE+
Introduction to Engage+
Engage+ Overview
Accessing Engage
Audience Management
Overview
About Audience Group Filters
Loyalty Based Filters
Transaction Based Filters
Campaigns & Coupons Based Filters
User Profile Based Filters
Lead Based Filters
Cart & Catalog Promotion Filters
Behavioral Event Based Filters
AI Powered Filters
Purchase Pattern/Behavior Based Filters
Common Filter Options (in filters)
Create Audience Group
Split Audience Group
Understand Audience Reachability Status
FAQs
Campaign Management
Introduction
Create Campaign
Referral Campaign
Survey Campaign
Bounceback or DVS Campaign
Broadcast Campaign
Ads Audience Campaign
Journey Campaign
Recurring Campaign
Manage Campaign
Configure Test and Control Ratio for Campaign
Edit Live Campaign
Search/Filter Campaign
Test Campaign
View Campaign Reports
Configure Campaign Settings
Manage Campaign Message
Create Message
Approve Message
Schedule Message
Reject Message
Stop Message
View Message Details
Journey
Overview
Create Journey
Configure Journey
Configure Events and Conditions
Upload Store Data in User Event
Building Blocks of a Journey
Overview
Engagement Building Block
Flow Control Building Block
Action Building Block
Manage Journey
Manage Live Journey Version
Duplicate Journey
Test Journey
Block-Level Reporting in Journey
Search User Journey History
FAQs
Engagement Channels
Introduction
SMS
Configure SMS Settings
Configure SMS Template & Content
Configure Link Tracking in SMS
Use Case
Email
Configure Email Settings
Configure Email
Use Case
FAQs
Call Task
Configure Call Task Settings
Create Call Task Template
Configure Call Task Content
Use Case
WhatsApp
Configure WhatsApp Settings
Create WhatsApp Template
Configure WhatsApp Content
Manage WhatsApp Subscription
Use Case
Wechat
Create Wechat Template
Configure Wechat Content
Viber
Configure Viber Settings
Create Viber Template
Configure Viber Content
Push Notification
Configure Push Notification Settings
Create Push Notification Template
Configure Push Notification Content
Creating and Sending Push Notifications
Reporting
Optimizing Delivery
Push Notification Regulations
Frequently Asked Questions
Use Case
RCS
Configure RCS Settings
Create RCS Template
Configure RCS Content
Zalo
Configure Zalo Settings
Create Zalo Template
Configure Zalo Templates for Campaigns and Journeys
In-app Message
Configure In-app Settings
Create In app Template
Configure In app Message Content
Send In-app Message on Campaign
Reporting
Use Case
LINE
Configure LINE Settings
Create LINE Template
Configure LINE Content
Send LINE Message on Campaign
Frequently Asked Questions
Configure Delivery Settings
Configure Channel Priority
Test and Preview across engagement channels
FAQs
Personalisation
Labels
Supported Labels across Engage+
Custom Tags
Add Dynamic Content Using Liquid
Add Dynamic Content Using Custom Fields
Incentive Management
Cart Promotions
Overview
Introduction
Core Concepts
Configuring Cart Promotion Redemption
Types of Cart Promotion
Create and Manage Cart Promotions
Create a Cart Promotion
Edit or Disable a Cart Promotion
Cart Promotion Settings
Preventing Fraudulent Redemptions
Example Use Cases
FAQs
Points Strategy
Gift Vouchers
Introduction
Configure Gift Voucher
Manage Gift Voucher
Gift Vouchers Settings
Badges in Campaigns
Offers (coupons)
Introduction to Offers
Getting Started
Coupon Management
Using Offers in Campaigns
Event Notifications
Reporting
FAQ
Settings
FAQs
INSIGHTS+
Getting started
Overview
Product navigation
Terms and abbreviations
KPI and dimensions
List of KPIs and Dimensions
Create Concept Hierarchy on Insights+
Charts
Overview
Create Chart
View Chart Details
Edit Chart
Delete Chart
Advanced Filter
Reporting
Types of Reports
Standard Report
Custom Report
Overview
Create and Publish Custom Report
Edit or Delete Custom Report
Share Custom Report
Archive Custom Report
Managing Reports
View or Access Report
Analyse reports Based on Audience Groups
Download Report
Explore Charts in Reports (Explore Mode)
Apply Dimensions to Charts
Target Setting & Tracking at KPI level
Schedule Report
Share Report URL
Filters
Date range filter & comparison with previous period
Apply filters in report
Audience group filter in reports
Fact & Dimension Tables
Fact tables
Bill Line Items Fact Table
Daily Till Summary Fact Table
Payment Details Fact Table
Return Bill Line Item Fact Table
Customer Summary Fact Table
Profile Users Fact Table
Registration Event Fact Table
Nsadmin Messages Fact Table
Goodwill Requests Fact Table
Points Fact Tables
Coupons Fact Table
Badges Fact Table
Streaks Fact Table
Journeys Fact Table
Milestones Fact Table
Rewards Fact Tables
Invitation Sent Fact Table
Referrals Fact Table
Referrers Fact Table
Contact Info Fact Table
Response Info Fact Table
Communication Credits Log Fact Table
Email Click Stats Fact Table
Custom Field Data Fact Table
Customer Merge Log Fact Table
Customer Notes Fact Table
Issue Tracker Fact Table
Call Task Customer Status Fact Table
Slab Change Log Fact Table
Earned Promotions Fact Table
Issued Promotions Fact Table
Partner Program Enrollment Fact Table
Partner Program Slab History Fact Table
External Partner Program Table
Partner Program Slab History Fact Table
Supplementary Partner Program Fact Table
Partner Program Linking Fact Table
Dimension tables
Use case based schema explain
Points awarded/deducted scenarios
Return after redemption scenarios
Customer Segmentation
Introduction to customer segmentation
Create segments through file upload
Create segments using scheduled FTP upload
Create segments using filters
Segment Creation Using SQL Traits
Data export
Introduction to Export Templates UI
Standard Templates
Return Transactions Standard Export Template
Responsed Standard Export Template
Contacted Standard Export Template
Transactions Standard Export Template
Payment Mode Standard Export Template
Tracker Value Standard Export Template
Customer Merge Event Log Standard Export Template
Slab Change Log Standard Export Template
Issue Trackers Standard Export Template
Messages Standard Export Template
Call Tasks Standard Export Template
Footfall Standard Export Template
Profiles Standard Export Template
Points Standard Export Templates
Members Standard Export Template
Coupons Standard Export Template
Badges Standard Export Templates
Registration Event Standard Export Template
Goodwill Requests Standard Export Template
Invitation Sent Standard Export Template
Custom Templates
Dimensions & attributes
Schedule an Export Job & Fetch Details
Create an export job (Step 1 of 3)
Select Data Templates (Step 2 of 3)
Modify Template & Creating Schedule (Step 3 of 3)
Edit an Export Job
Reuse an Export job (Duplicate)
Export Audience Group
Use Cases on Data Export
External Facts
Data export FAQs
Configure SFTP server for data export
Fraud Management
Fraud Detection Rules
Methodology
Use Case for Score Calculation
FAQs
BI Tool Connector
Connect Power BI and Tableau Desktop to Databricks
Viewing Power BI Dashboards on Insights
Custom Namespace for Organisation
Data Encryption Settings
REWARDS+
Getting Started with Rewards+
Rewards+ Overview
Types of Rewards Supported by Rewards+
Sources for Rewards+
Core Components
Ingestion and Extraction (Data import & export)
Rewards+ Agent Support Tool
Rewards+Dashboard
Example and Sample Rewards+ UI
DEVELOPER DOCS
Neo Extension
Quickstart for Neo Extension
Use Cases
Customer Name Validation for Loyalty Point Allocation
Asynchronous High-Volume Data Processing for Loyalty Point Allocation
Event Notification Enrichment
Introduction
Overview
Enabling & Managing Access to Neo
Introduction to the UI
Core Concepts
Dataflow & Building Blocks
Block Libraries
Configuration & Setup
Configuring Conditions
Configuring Relations
Configuring Caching
Building Block Configuration
Trigger Block
Schema Block
Script Block
API Request Block
GET Mongo Block
PUT Mongo Block
Bulk Upsert Mongo Block
Redis Evict Block
Kafka Block
HMAC Block
Encrypt Block
Decrypt Block
OAuth Block
OrgContextSwitch Block
Cache Manager Block
Manage Dataflow
Composing a Dataflow
Review and Approval of a Dataflow
Dataflow States
Editing a Dataflow
Deactivating and Activating a Dataflow
Viewing Dataflow List
Promoting Dataflows Across Organizations
Neo DAO Functions
Organize Dataflows
Organizing Dataflows using Tags & Filters
Organizing Dataflows using Applications
Execution & Monitoring
Advanced Features
Access Sensitive Data in Neo Dataflows Using Configuration Manager
Dataflow Versioning
AI-Assisted Dataflow Creation in Neo using Aira Coder
Overview
Create a Dataflow
Modify a Dataflow
Copy and Paste a Dataflow
Summarize a Dataflow
Ask Documentation Related Questions
Known Limitations
FAQs
Dev Console
Introduction
Handle Deployment
View API Logs
View API Performance Metrics
View App Request Logs
Save Extension Configurations
Connect and Manage DB
Alert Management
FAQs
Vulcan
Examples
Creating a Microsite Using Vulcan
Customising the Member Care UI
Introduction
Getting Started
Application Development Process
API Management on Vulcan
Troubleshooting
FAQs
SDKs
Android SDK
Getting Started
Configure Firebase
Configure Source Account
Configure Gateway
Install SDK
Initialise SDK
Configure Push Notifications
Configure In-app Messaging
Configure Notification Center
API Reference for Event Tracking and User Lifecycle Management
Xiaomi push notification (Push Amplification)
iOS SDK
Getting Started
Configure Source Account
Configure gateway
Install SDK
Initialise SDK
Core Features
Configure Push Notifications
Configure Rich Push Notifications
Configure In-app Messaging
Configure Notification Inbox
API Reference for Event Tracking and User Lifecycle Management
React Native SDK
Getting Started
Install React Native SDK
React Native Setup Overview
Configure Push Notifications
Configure In-App Messaging
Configure Notification Center
API Reference for Event Tracking, Notifications, and User Lifecycle
Flutter SDK
Getting Started
Install Flutter SDK
Advanced Platform Setup
Flutter Setup Overview
Configure Push Notifications
Configure In-App Messaging
Configure Notification Center
API Reference for Event Tracking, Notifications, and User Lifecycle
ADMIN CONTROLS
Organization
Independent organization
Organization Units (OU)
Connected Organizations
Entity-specific Behaviour in a Connected Organization
Organization Management
(New) User Management
Overview
Types of Users in the Organization
Managing Permissions for the Users
List of Standard Permission Sets
Manage Custom Permission Sets
Assign Permission Set to Users
Manage Permission for Users in Multiple Organizations
Onboarding and Managing Users
FAQs on User Management
Credit management
Setup Localization
Localisation management
Single Sign On (SSO)
API Gateway Integration with CIAM Platforms
API Security
Authentication
Authorization
Data Privacy
Setup Subscription
Unified Subscription
Classify Data as PSI and PII
Setup OTP Verification Rules
Data Deletion
Introduction
Performing Data Deletion
How Data Deletion Works and What Data is Deleted
Handling Customer Cards During Data Deletion
FAQs
Data Masking
Overview of Data Masking
How Masking is Enforced in Databricks
Mask OTPs
InTouch password security and account lockout
Channel configuration
Reset Password Using Import
Identity Access Management
Overview
Customer IAM (CIAM) for end customers
Auth for First-Party Apps
oAuth2 Authorization Code Flow and SSO for Partner Apps - Using Ory Hydra
Integration with External CIAMs
Machine-to-machine (M2M) IAM for services
OAuth2 Client Credentials Flow
Basic Authentication
Workforce IAM for Employees
Single Sign On (SSO) Using Okta
Authentication Scenarios and Recommendations
ANNOUNCEMENTS
Release Notes
2026
January-February-March 2026
April - May - June 2026
July - August - September 2026
2025
January-February-March 2025
April - May - June 2025
July - August - September 2025
October-November-December 2025
2024
January-February-March 2024
April-May-June 2024
July-August-September 2024
October-November-December 2024
2023
January-February-March 2023
April-May-June 2023
July-August-September 2023
October-November-December 2023
2022
January-February-March 2022
April-May-June 2022
July-August-September 2022
October-November-December 2022
2021
January-February-March 2021
April-May-June 2021
July-August-September 2021
October-November-December 2021
MCP SERVER
MCP
PARTNER INTEGRATIONS
Data & Audience
Adobe Integration
Overview
Integration Set-up (Capillary to Adobe)
Data Migration - Capillary to Adobe
Supported Events
Engagement Channels
Email
SendGrid
Vendor Integration other than SendGrid
SMS
Vendor integration other than supported vendors
Powered by
CAPILLARY DATA PLATFORM
Data import
Payment Mode Profile
Copy Page
