Tracardi Documentation
Gui source
Initializing search
tracardi/tracardi-api
Tracardi Documentation
tracardi/tracardi-api
Introduction
Getting started
Getting started
Tracardi Getting Started
Tracardi Concepts
Tracardi Components
Tracardi Components
Bridge
Types of Bridges
Types of Bridges
REST API Bridge in Tracardi
Webhook bridge
Redirect Bridge
Event source
Session
Event
Types of Events
Types of Events
System Events
Profile-less events
Ephemeral events
Pre-build event types
Profile
Workflow Trigger
Workflow
Resource
Resource
Resource Definition
Documentation
Documentation
Elastic email resource
Matomo Credentials
Novu resource
Redis resource
Activecampaign resource
Airtable resource
Amplitude resource
Aws resource
Civi resource
Fullcontact resource
Hubspot resource
Mailchimp resource
Mautic resource
Meaningcloud resource
Microservice resource
Mongo resource
Mysql resource
Postgresql resource
Pushover resource
Rabbitmq resource
Scheduler resource
Sendgrid resource
Influxdb resource
Mixpanel resource
Mqtt resource
Salesforce resource
Zapier resource
Chatwoot resource
Elasticsearch resource
Sms77 resource
Twitter
Discord
Ga4 tracker resource
Github resource
Ua3 tracker resource
MaxMind Cloud Services
Telegram Bot Configuration
Twilio resource
Weaviate
ClickSend API Configuration
Apache pulsar resource
Ghost resource
S3 aws
Action or Action Plugin in Tracardi
Destination
Tracardi Definitions
Tracardi Definitions
Traffic
Tracker Payload
Metadata
Customer Consent
Credentials
Extension points
Identification point
Tracardi Codings
Tracardi Codings
Tracardi Notations and Codings
Dot notation
Logic notation
Object template
Templates
Event validation schema
Searching
Tracardi Processes
Tracardi Processes
Preconfiguration
Integration
Types of Integration
Types of Integration
API integration
Javascript integrations
Redirect Link
Data collection
Tracking
Identity Resolution
Merging
Automatic Profile Merging (APM) Documentation
Automation
Automation
Automation Types
Workflow Core Definitions
Actions
Actions
None
Action Documentation
Action Documentation
Commercial
Commercial
Pause and resume
Run In Background
ChatGPT prompt
Event Aggregator
Event Counter
Generic UIX Plugin
Limiter
Load report data
OpenReplay UX
Pause and Resume
Sequencer Matcher
Event Sequence
Send SMS
Delete vector
Vector exists
Load vector
Store vector
YouTube widget
Tagging
Tagging
Add segment
Delete segment
Move segment
Profile segmentation
Operations
Operations
Update Event Action
Merge profiles
New profile
Update Session Action
Stats
Stats
Increment action
Decrement action
Key counter
Connectors
Connectors
Zapier webhook
E-mail via SMTP
Remote call plugin
Full contact webhook
RabbitMQ publisher
Pushover push
Weather plugin
Get OAuth2 token plugin
Send to InfluxDB plugin
RabbitMQ publisher
Fetch data from Airtable plugin
Fetch from InfluxDB plugin
Elasticsearch query plugin
None
ContainsString Plugin
EndsWith Plugin
StartsWith Plugin
Weekdays checker plugin
Databases
Databases
Mongo connector
Mysql Connector
Send data to Airtable plugin
Messagers
Messagers
Post to Slack channel plugin
Discord webhook plugin
Telegram post plugin
Novu
Novu
Novu trigger plugin
Elastic mail
Elastic mail
Send bulk e-mail plugin
Add contact to Elastic Email plugin
Add contact to Elastic Email plugin
Trello
Trello
Add Trello card plugin
Add Trello member plugin
Remove Trello card plugin
Move Trello card plugin
Mautic
Mautic
Add contact to Mautic plugin
Fetch Mautic contact by email plugin
Fetch Mautic contact by ID plugin
Edit points in Mautic plugin
Edit segment in Mautic plugin
Mixpanel
Mixpanel
Fetch funnel from MixPanel plugin
Send to MixPanel plugin
Mailchimp
Mailchimp
Send transactional e-mail plugin
Add to MailChimp audience plugin
Remove from MailChimp audience plugin
Sales force
Sales force
Salesforce Data Extension plugin
Active campaign
Active campaign
Fetch contact from ActiveCampaign plugin
Add contact to ActiveCampaign action
Hubspot
Hubspot
Get company from HubSpot plugin
Get contact from HubSpot plugin
Update company from HubSpot plugin
Plugin documentation
Plugin documentation
Update contact from HubSpot plugin
Sendgrid
Sendgrid
Send bulk e-mail plugin
Add contact to Sendgrid plugin
Send bulk e-mail plugin
Google
Google
Google Analytics Event Tracker
Google analytics 4 event tracker
Matomo
Matomo
Matomo register event
Regex
Regex
String Validator
Regex Match
Regex string replace plugin
Locations
Locations
GeoLite2 Plugin
Time
Time
Day/Night
Local time span action
Calculate Time Difference Plugin
Today
Time Delay
Processing
Processing
Parse URL
String splitter
String properties and transformations
Value mapping plugin
Validators
Validators
Validate with JSON schema plugin
String Validator Action
Get field type plugin
Machine Learning
Machine Learning
Text Classification
Language detection Plugin
Sentiment analysis action
Corporate reputation plugin
Categorize text plugin
Summarize text plugin
Extract topics plugin
UX
UX
Show question popup plugin
Rating Popup Plugin
Show contact popup plugin
Chat
Chat
Chatwoot widget
Intercom widget
LiveChat widget
Zendesk widget
Memory
Memory
Write to memory plugin
Read from memory plugin
Memory payload collector
Consents
Consents
Add consent plugin
Has consents
Errors
Errors
Log message plugin
Throw error plugin
Other
Other
Action's Core Definitions
IF Action
Elastic email contact action
Send transactional e-mail plugin
Detect client agent action
Inject values
Event scheduler
Get previous event plugin
Get Previous Session
New Event Action
New visit
Event counter
Resolve conditions
Count records by query string plugin
Create payload action
Template Plugin
Append/Remove data plugin
Start plugin
Decode Base64
Encode Base64
Data check action
Load profile by ...
Sort array action
Sort dictionary
Join string list
String similarity
Send Twitter tweet plugin
GeoIp service
Send SMS with Sms77 gateway
Calculator
Return random item
Assign condition results plugin
Reduce array plugin
Password generator
Contains Pattern Plugin
Google translate plugin
Join
Limiter plugin
Merge data
Add Empty Profile
Add Empty Session
Add Interest
ClickSend Send SMS
Copy data
Cut out data
Data to JSON
Decrease Interest
Delete data
End
Geo distance
Get Event Source Plugin
Get Issue
Google Spreadsheet
Has Segment
Hash data
HTML fetcher
Increase Interest
Inject Event
JSON to data
Last Profile Visit Time
List Issues
Mask data
Merge event properties
Microservice
Profile live time
Query Local Database
Show consent bar
Sleep
String splitter
String to Date
Tag Event
Time Difference
Update Event Action
UUID4
Whois Plugin
XPATH HTML Scrapper
Circular Geo Fence
Find Max Value
Set Operation Plugin
String Replace
Save Integration Id
Assign profile id plugin
Load Integration Id
Ghost
Group and Rank Interests
S3 Segments Uploader Plugin
Force segmentation
Has segment
Audiences and Activations
Orchestration
Architecture
Architecture
Architecture of Tracardi
Installation
Installation
Dependencies
Dependencies
Installing Dependencies
Docker Installation
Docker Installation
Elasticsearch
MySql
Apache Pulsar
Redis
DEB Installation
DEB Installation
Elasticsearch
Helm Chart
Helm Chart
Elasticsearch
Mysql
Pulsar
Redis
Open Source
Open Source
Open-Source Installation
Docker
Docker
Docker-based Tracardi Open-Source Installation
Open-source Tracardi with docker compose
Commercial
Commercial
Commercial Installation
Docker
Docker
Docker-based Tracardi Commercial Installation
Commercial Tracardi with docker compose
Kubernetes
Kubernetes
Helm-Based Production Installation
Helm
Helm
Installation with HelmChart version 0.8.2
Installation with HelmChart after version 0.9.0
Configuration
Configuration
Tracardi configuration
Configuration Best Practises
Multi tenant configuration
Scaling
Scaling
Data Partitioning
Scaling Commercial Tracardi
Staging server
Dependencies
Dependencies
Elasticsearch
Elasticsearch
Connecting Tracardi to ElasticSearch via SSL
Connecting elasticsearch cluster
Elastic search authentication
Max connections to elastic
Elastic sniffing
Upgrade
Upgrade
Tracardi Upgrades before version 0.9.0
Development
Development
Developing in Tracardi
Environments
Environments
Api source
Gui source
Tutorials
Tutorials
Plugin
Plugin
Code Workflow Plug-ins
Part 1: Code simple plugin in Tracardi
Part 2: Configuring the plugin in Tracardi
Part 3. Data reference and resource in plugins
Code Widgets
Code Resource
Code Destination
Dockers
Dockers
Building Docker Image
Build SSL Docker
Q&A
Q&A
System architecture
System architecture
Inbound Traffic
Inbound Traffic
What is bridge?
What is event source?
What is the difference between bridge and event source?
Events
Events
What is event?
What is event property?
What is event context?
What is event tag?
Profile and session
Profile and session
How can you copy data from events to profiles?
How can I load profile in workflow?
How can I load session in workflow?
Where profile visits are stored?
How profile, event and session ids are tied up together?
Why this is a security risk to use simple profile and session id?
Why do I have session-opened when first event is collected?
What is Auxiliary data?
What is Miscellaneous data in profile.
What is session?
What is profile?
Entities
Entities
What are entities and how can I use them.
Installation and upgrades
Installation and upgrades
How to upgrade Tracardi in GUI?
What is major version upgrade?
What is minor version upgrade?
What does the open source Tracardi worker do?
How Tracardi is upgraded?
Why is my background task in a pending state?
How automate the installation process for a new tenant?
What are available types of installation. Can Tracardi be installed in kubernetes?
What are the differences between major and minor upgrades
How to automate retrieval of the API KEY to Tracardi?
What are the prerequisites, requirements for Tracardi to install
What should I pay attention to when setting up production ready Tracardi.
Multi-tenancy
Multi-tenancy
What is multi-tenant set up?
None
How to configure Tracardi to be multi tenant?
None
How to start Tracardi in multi-tenant mode?
How Tenants are differentiated in Tracardi multi-tenant environment?
How to create new tenant
Mutli-tenant management service (TMS)
Mutli-tenant management service (TMS)
What is Tenant Management Service (TMS)?
How to use tenant management service API.
What is tenant management service responsible for?
How to integrate TMS with Tracardi?
Licensing
Licensing
Can I make changes under commercial license?
Examples of what is and isn't allowed under the Common Clause license ?
Can I sell Tracardi under standard license agreement?
Can I use Tracardi for my own project for free?
What are the basic terms of Tracardi commercial agreement?
Will I be vendor locked if I use Tracardi?
Do I need a commercial license to host Tracardi as SaaS?
Integration
Integration
Where to place javascript integration code?
How to integrate external systems using webhooks
How to get integration javascript that I put on my web page?
How to use own profile id?
My javascript is not sending events
Why webhook events dot not have session and profile?
Mailchimp
Mailchimp
How to get API Key for one-to-one transactional e-mails
To check the verified domain registered in Mailchimp, you can follow these steps:
How to send mails with mailchimp
I get error API Invalid from Mailchimp
Does tracardi integrate with Mailchimp?
Tracking
Tracking
How to Track Links and Viewed Images?
How to send event when I click something?
How to collect event on the external click
How tracardi loads profile
When will I know that my event was processed?
What is the difference between redirect link and parametrized link in tracardi?
How to send my own profile ID and disable profile ID regeneration?
Workflow
Workflow
How to Replace a Profile in Workflow?
How to use workflow editor?
How to quickly copy node configuration from node to node (action to action)?
How to delete a node in the workflow?
My workflow is not working
What plugins has Tracardi?
Extensions and plugins
Extensions and plugins
How to install extension?
What extensions are in Tracardi ?
What extensions are in Tracardi
Can Tracardi use ActiveCampaign ?
How to write some simple code of tracardi plugin
Basic code template for tracardi plugin?
Commercial version
Commercial version
How can I benefit from commercial license?
How can I benefit from partnership with Tracardi?
What are the differences between open-source and commercial Tracardi
What are major open-source competitors to Tracardi?
How tracardi compares to other platforms in terms of pricing schemas
Cost and Competitors
Cost and Competitors
What is the cost of Tracardi?
What is the difference between Tracardi and Segment.com
What is the difference between zapier and tracardi
What are the main differences between Apache Unomi and Tracardi?
Reporting
Reporting
How can I use reports?
None
Where can I find report id.
Segmentation
Segmentation
How to do simple segmentation with number of visits.
How segmentation is triggered in Tracardi?
Why my post event segmentation does not work?
Give me examples of real time segmentation?
Why my live segmentation does not work?
My live segmentation does not change profile traits?
How live segmentation works from technical point of view?
How post event segmentation work?
How to aggregate events for segmentation?
Backups
Backups
Does tracardi has its own backup system?
How backups are done in Tracardi.
Data import
Data import
Can Tracardi import data from CSV files and external sources using a secure API?
How to import data to Tracardi
Importing Data to Tracardi Documentation
General
General
How to Tracardi stores UTMs?
What is the difference between event traits and properties and what is event indexing?
How many records can tracardi store?
How import data and fix an error of import pending?
I have ValidationError when calling webhook
Passing Profile ID in the URL Between Owned Domains (Cross Domain Event / Cross Domain Identification)
Who is Tracardi for? How can I benefit from installing Tracardi?
Can I send marketing campaigns from Tracardi? Is Tracardi a Marketing Automation Platform?
Can I use Tracardi for free?
Can Tracadi use ChatGPT?
How do I filter data? What query should I use to filer data?
Can I add custom event timestamp?
Can I only process the event?
Can you describe Tracardi components?
Do I have to define custom properties
How can I use reports in Tracardi?
How can I authorize and get API KEY
Does the pause event impact the performance? Causing the workflow cannot complete in several days.
How tracardi process event context
How to purge events, sessions, and profiles?
How does Tracardi Bot work?
What are the main components or modules that make up Tracardi?
What are session opened and visit opened meant for?
What is customer journey?
What is ephemeral transactional event source?
What is the architecture of Tracardi?
What does staging mean in tracardi version?
When can I use Tracari for free?
Where can I store custom profile properties.
How to personalize messages?
How tracardi calculate the visits
What are build-in event types?
What is dot notation?
Is it possible to use Kafka as the primary source of events for Tracardi, where events from various channels are initially published to Kafka?
How to get started with data collection from the website.
How can I get Telegram bot token and chat ID?
How can I update event?
How do I get my own event source id?
How the profile is loaded?
What are the main features of commercial vs open-source version?
What Happens When Two Workflows Generate Responses
What occurs when two workflows yield widgets
What is event redirect
Difference between 'Assign data to profile from event' and a workflow to map data from event to profile
What is the sequence of event processing
What is the syntax of IF plugin condition
What is Tracardi Flusher?
What are event options, how the impact triggering of events from javascript?
I can not connect to http://localhost:8686 when using docker.
What is Tracardi?
Other Q&A
Can Tracardi retrieve data about a provided email from the FullContact service?
Where do I store the unique identifier for each event?
Where do I store the unique identifier for each profile?
How to test workflows?
How can Tracardi be installed as a Docker container?
How can I add new action nodes to Tracardi?
Could you please explain why there is no drop-down list or other options in the ‘destination’ field in the outbound traffic?
A have sent event form javascript using window.tracker.track but I do not see it in Tracardi. This is the code:
In the Start plugin, you can only select a predefined event from the list. What if you need a custom one? For example, event “my-event”? If I write it in the required field, it does not be save. How do I add new events?
How many events can handle Tracardi?
How profile is restored? Why my tracardi profile is restored even if I deleted it from the localStorage in browser.
How the profile is tracked?
How to insert variables into the request body in a Remote API call?
How to add action plugin class to the system?
How can you calculate something under aggregation conditions? How to count the number of events that meet given conditions? For example, how do I calculate purchases over the last 7 days? Or how do I calculate all purchases over 100 dollars in the last 7 days?
How to create report
How to collect consents and use consent box widget to obtain customer consents.
How to make the initial loading of the data and how to update it constantly? We want to add user data to the profile from an external resource (Database). And how to upload a new profile if we have nothing on the user in Tracardi?
How to store interests in Tracardi
How Tracardi use javascript snippet to collect events?
How can I track marketing campaigns with tracardi?
How tracardi segments profiles
How tracardi tracks customers?
How workflow works. What are the steps during workflow execution?
How workflow segmentation works
My data was not migrated how can I debug what happened?
Which fields can be used to merge profile?
What parameters should I tweak for production environment
Which resources in tracardi can be used to send data and be treated as data destinations.
What are extension points?
What are the differences in Data Flow for Open-source and Commercial Version of Tracardi
What are plugins
How data is collected and what stages there are before the event is saved.
Understanding Data Partitioning in Tracardi
What is the difference between the segment and audience?
How the progress of Tracardi upgrade looks like.
What segmentation types are in oen-source version.
When loading I Have the error Redis Authentication?
Where can I save in profile such timestamp like last visit, last message send, last contact, etc ?
'm using my own code to send an event with window.tracker.track, but it's not showing up in Tracardi. What should I do?
Do I need to keep copy data and merge profile actions in one workflow?
Why does debugging fail to function even though the workflow runs correctly during normal execution?
How can I send the event of a customer leaving the page?
How to set custom event time in API payload?
Can I use API to create profile not tracking script?
Is there a way to disable Pulsar in Commercial Tracardi?
Current version has a different profile structure than the previous version. Who sets this structure? Does it come out of the box, or can it be administered?
Why my migration do not start?
Where can I find AD ACCOUNT ID.
How to start with Facebook integration
How to get access token.
Scaling Commercial Tracardi
I use commercial version and I do not see my widget
What are the pros and cons of multi-tenant setup of Tracardi?
Are events linked to profiles before they are sent to the destination in the data integration process?
How to move events to warehouse.md
What are the differences between profile and session ID:
What schema has event traits?
How APM (Automatic Profile Merging) Watchdog works?
How to enable ND configure AMP?
There are prefixes in the profile IDS what they mean?
What are the recommended versions of dependencies for Tracardi
When profiles are marked for merging?
Describe some of the merging scenarios.
Does the system store an update timestamp for each field in a profile?
How Merging Strategies are Matched
How to configure number of shards?
How to download tracardi helm chart repo?
How to enable system events?
How to enable/disable system events in docker?
How to enable system events in docker compose?
How to enable system events in helm chart?
How to Install ElasticSearch Cluster on K3s/K8s?
How to install kubernetes for Tracardi
How to Install MySQL Using Percona on Kubernetes
How to Install Redis on Kubernetes?
What are available merge strategies?
What is a set of strategies
What is cross domain click?
What is Merge Strategy Fallback?
What is merging strategy?
What is the difference between Open-source and CCommercial Tracardi.
What is the minimum RAM for Elasticsearch to run Tracardi?
What is the minimum ram mysql needs to run Tracardi?
What upfront decisions do I have to make before I install production ready Tracardi.
Which environment variables should I set before production installation?
Why my script is not sending events
Why are some of the update timestamps on profile fields different?**
What does the error message "Address already in use" in Tracardi mean?
Why I have this error: Invalid data reference. Dot notation event@... could not access data?
Error "The GUI version 0.8.0 does not match the API version"
I have error No plugin for id xxx. What could be a reason for this?
I have error "Tenant not allowed"
Troubleshooting "Network Error" when Selecting the API URL
I have this error: tracardi.exceptions.exception.StorageException: NotFoundError(404, 'index_not_found_exception', 'no such index [01506.tracardi-event-validation]', 01506.tracardi-event-validation, index_or_alias)
I have an error when executing report
In version 0.8.2.1 I got this error what should I do
When I start multi-tenant installation I get the error: "Installation forbidden. Tenant XXX not allowed"
How can the "Address already in use" issue in Tracardi be resolved?
What could be the cause of the "Index index 'INDEX_NAME' was NOT CREATED" error during Tracardi update?
What does the error message "Cannot connect to host elasticsearch:9200 ssl:default [Connection refused]" indicate in Tracardi?
Why does the Tracardi API connection with Elasticsearch fail when using "localhost" as the ELASTIC_HOST?
What causes the "Failed to index document" error in Tracardi, and how can it be solved?
What is the reason for the "Failed connection with error: CORS request did not succeed" error in Tracardi API connection?
What issue can occur when using the "/track/" endpoint with HTTPS connection in Tracardi?
Error descriptions
Error descriptions
WARNING: No MULTI_TENANT_MANAGER_URL set for MULTI_TENANT mode. Either set the MULTI_TENANT_MANAGER_URL or set MULTI_TENANT to "no"
WARNING: No MULTI_TENANT_MANAGER_API_KEY set for MULTI_TENANT mode. Either set the MULTI_TENANT_MANAGER_API_KEY or set MULTI_TENANT to "no"
WARNING: Env MULTI_TENANT_MANAGER_URL is not valid URL.
WARNING: Env MULTI_TENANT_MANAGER_URL is not valid URL.
WARNING: Can't find the index X. Migration for this index will be stopped.
ERROR: Installed system version is X for tenant A, but migration script is for version Z for tenant B.
ERROR: Could not find multi indices for X
ERROR: Rule to workflow does not exist. This may happen when you debug a workflow that has no routing rules set but you use Background task or Pause and Resume plugin that gets rescheduled and it could not find the routing to the workflow. Set a routing rule and this error will be solved automatically.
ERROR: Rule 'name:id' validation error: Description
ERROR: Could not find flow X
ERROR: Entity X does not have index set. And it is not new.
WARNING: Entity X converts to index-less storage record.
License
License
Tracardi licensing
Open-source license
Standard Commercial License
Support us
Documentation license
Gui source
Back to top