documentation

Transform raw content into searchable knowledge through AI-powered indexing and vector embeddings

Overview  The complete knowledge management process for an AI Agent consists of 3 layers: AI Agent Response Generation Workflow : Knowledge Indexing Document processing Embedding generation Vector storage Query Processing & Retrieval - Query Rephrasing Chunk Retrieval Ranking/Reordering Response Generation Answer formation Response delivery The Indexing process represents the first layer of the knowledge management process, positioned before query processing and final response generation. Why is Indexing required? Indexing is the foundational step when connecting any knowledge source with your  AI Agent. When you add a knowledge source - whether it's documents or multimedia content - the indexing process is used to transform this raw information into a format your agent can effectively understand and use to generate responses.Content from knowledge source is segmented into optimized chunks and transformed into (embeddings) that are stored into a vector database on the platform. All these steps ensure a better and cohesive response from your AI Agent. Do the users need to do it manually? No. Unify’s AI Agent setup provides an out of the box and best in class indexing setup which automatically processes any new knowledge source which is added. However, users have the option of defining their own custom indexing settings as per the process defined below. How Indexing Works? Let's walk through what happens when you add a document to your AI Agent's knowledge base, for example, a company policy document about employee leave procedures. Step 1: Document Upload and Initial Processing When a document is added to your AI agent's knowledge base, the system first identifies its format (PDF, Word, text, etc.). This initial processing stage prepares your document for the subsequent chunking phase by analyzing its structure and organizing the content into processable segments. Step 2: Breaking Down the Content (Chunking) The system breaks down your document into smaller, manageable pieces. Each Agent comes with a Default Strategy that applies standard chunking settings across all document types, but you can create custom strategies for different content types by clicking the "New Indexing Strategy" button. This flexibility is important because different types of content require different handling: Text, Image, Audio, and Tabular Data (as shown in the tabs) each have unique characteristics: Text documents might need specific chunk sizes and splitting algorithms Images require a text extraction model. Audio modality needs transcription settings. Tabular Data can be indexed through tables to sql or by generating simple embeddings. Each chunk maintains enough context to be meaningful while being small enough for efficient processing. Step 3: Converting to Vector Format (Embedding) Each chunk is converted into a numerical format (vectors) using your selected embedding model (e.g., text-embedding-3-small): Text is transformed into a series of numbers These numbers represent the meaning and context of the text Similar content gets similar number patterns You can choose your own embedding model by selecting from the list of available models under embedding model settings.  Step 4: Storage and Organization All the vector embeddings and  processed information is stored in the vector store object within the UnifyApps platform.However we can also customize external vector databases to generate responses depending on organizational requirements. How It Works in Practice? When someone asks: "What's the process for requesting annual leave?" Query Processing Question is converted to the same vector format System searches for similar vectors in the stored data Retrieval Matches are found in the relevant chunks System pulls the appropriate section about annual leave Response Generation AI uses the retrieved chunks to formulate an accurate response Returns the specific policy details about requesting leave Refined and well structured indexing settings can help in ensuring  Faster response times More accurate answers Better understanding of context Configuring Indexing Settings To configure the Indexing process in UnifyApps AI Agents, follow these easy steps: Select an Embedding Model to convert organized data into vector points for fast retrieval. This will enable efficient matching against user queries. For Indexing Strategies, Set the maximum number of characters allowed in each chunk of text to optimize retrieval in the “Max Chunk Size” field. Then, Choose the “Chunking Algorithm” for how the content will be split into chunks. You can also choose different algorithms for different MIME types and can customize indexing settings based on the MIME type. Optionally, you can add a delimiter to define where splits in the data should occur. You can toggle the “Use Summarizing Model” option to create concise summaries of longer text chunks. For Metadata Enrichment, Choose the “Processing Method” to process and extract metadata from your content. Then, “Select a Model” that will assist in metadata extraction. Optionally, you can add custom metadata Parameters to enrich the indexing process by clicking on the “Add Parameter” button. Define a “Vector Store” for storing the data that will be indexed. This storage helps quickly find and retrieve relevant data points. These steps allow you to organize and structure data efficiently for faster lookup and retrieval in UnifyApps AI Agents. The next step is preparing and optimizing user queries through rephrasing, chunk retrieval, and augmentation for effective processing, which are set up through pre processing settings.

Integrate your app with Quentn to automate marketing campaigns, manage contacts, and optimize customer engagement.

Quentn is a marketing automation platform that helps businesses streamline email campaigns, build sales funnels, and manage customer journeys with precision. It combines CRM, email marketing and behavior tracking in one user-friendly interface. Integrating your application with Quentn streamlines contact management, automates workflows, and enables efficient, data-driven marketing and customer engagement. Authentication Before you begin, make sure you have the following information: Connection Name: Select a descriptive name for your connection, like "MyAppQuentnIntegration". This helps in easily identifying the connection within your application or integration settings. Authentication Type: Quentn supports API Key authentication. API Key Based Authentication Login into Quentn and go to Settings. Click on API info. Select API base URL as your API URL. Click on Add key, then create an API key. Keep the API key and API URL secure as they provide access to your Quentn account. Actions Actions Description Create or update contact Creates a new contact, or updates an existing contact in Quentn Find contact Finds a contact by email address in Quentn Run campaign for contact Runs a campaign workflow for a contact in Quentn Triggers Triggers Description On campaign contact sent Triggers when a contact is sent via campaign in Quentn

Create custom connectors within the Unify platform to unify workflows

Overview Connector SDK is a module within UnifyApps that allows users to connect custom connectors within UnifyApps platform. Through this, customers can connect to any custom end point and start having a bi-directional connection (both receive & send data), through which they can take actions on external apps as well.  Why Connector SDK? In today's complex digital ecosystem, businesses often need to connect with proprietary systems, legacy applications, or emerging technologies that don't have pre-built connectors. The Connector SDK eliminates these integration barriers by providing a framework to develop custom connector solutions that work seamlessly within the UnifyApps environment. Key Features Custom Connector Management: Easily view and manage all your custom connectors in one centralized dashboard. The Connector SDK interface displays essential details like: Connector Name Status (Active/Inactive) Created By Created On Last Modified On Status Monitoring: Each connector shows a status such as "Active" or "Inactive," allowing you to quickly identify which custom integrations are operational and which may require attention. Version Control: Track when connectors were created and last modified, helping maintain proper documentation and governance, especially in collaborative development environments. Simplified Creation Process: With the New Custom Connector button, users can initiate the development of new connectors through a guided, step-by-step interface that streamlines the configuration and deployment process. Advanced Management Options: To efficiently handle multiple custom connectors: Use the search bar to locate specific connectors. Filter connectors by status or other parameters. Sort based on creation date, modification date, or name. Use Cases Development Teams can create specialized connectors for proprietary internal systems that don't have standard APIs. System Integrators can build custom connections to legacy systems that need to communicate with modern applications. IT Administrators can maintain and monitor the health of all custom integration points across the organization. Solution Architects can extend platform capabilities by developing connectors to emerging technologies and services. Getting started To begin using the Connector SDK: Navigate to the Connectors section in the UnifyApps Platform Tools. Click the "New Custom Connector" button in the top-right corner. Follow the guided process to configure and deploy your custom connector. For detailed instructions on creating your first custom connector, refer to our [Creating a Custom Connector] article. Example: How it looks in action Here’s a sample view from the Connector SDK dashboard As seen above, you get a clear and organized table view with sortable columns. Each row represents a unique Connector SDK, complete with relevant metadata for easier management.

Integrate your application with JobNimbus to manage leads, track jobs, and streamline your workflow processes efficiently

JobNimbus is a CRM and project management software designed for contractors, helping streamline scheduling, estimates, invoicing, and job tracking. It offers automation, integrations, and mobile access to improve efficiency and organization. Integrating your application with JobNimbus allows you to manage leads, track jobs, and streamline your workflow processes efficiently.  Authentication Before you begin, make sure you have the following information: Connection Name: Select a descriptive name for your connection, like "MyAppJobNimbusIntegration". This helps in easily identifying the connection within your application or integration settings. Authentication Type: JobNimbus supports Bearer Token authentication. This method ensures secure access to JobNimbus's functionalities and data. Bearer Token Based Authentication Log into your JobNimbus account and navigate to the Settings section from the menu. In the "API" tab, you will find your API Key. If an API Key is not generated yet, click on "New API Key" to create one. Copy the API Key and keep it secure, as it grants access to your JobNimbus account. Actions Actions Description Contact Created or Updated Triggers when a new contact is created or updated in JobNimbus Contact Deleted Triggers when a new contact is deleted in JobNimbus Job Created or Updated Triggers when a new job is created or updated in JobNimbus Job Deleted Triggers when a new job is deleted in JobNimbus Triggers Triggers Description Create Attachment Creates a new attachment in JobNimbus Create Contact Creates a new contact with a display name in JobNimbus Create Job Creates a new job in JobNimbus Find Contact by ID Searches for a JobNimbus contact by ID in JobNimbus Update Contact Updates an existing contact in JobNimbus

Integrate your app with IMAP to enable seamless email synchronization, real-time access, and enhanced communication workflows.

The IMAP connector seamlessly integrates with email servers, enabling efficient mailbox access. It provides robust capabilities for managing, retrieving, and organising emails securely. Integrate your IMAP server with UnifyApps to seamlessly access your emails in workflows and process them via many other applications.  Authentication Ensure you have the following information ready for a better integration experience: Connection Name: Choose a meaningful name for your connection. This name helps you identify the connection within your application or integration settings. Host: The host domain name of your IMAP server. For example, if you are using gmails's IMAP server, the host is imap.gmail.com Port: The port at which the IMAP server is listening. By default, IMAP servers run on 143 unencrypted or 993 with SSL/TLS. Allow Multiple Clients: By default, IMAP supports only a single client since it deletes any mail fetched for the first time from the server. However, support for multiple clients can be enabled explicitly if required. Enable this flag to ensure multiple clients can access the same mail. SSL: Enable this option to use SSL (Secure Sockets Layer) for a secure connection. SSL establishes a secure, encrypted link between your client and the server. This is commonly used for email protocols and ensures your data is protected during transmission. Start-TLS: Enable this option to use STARTTLS to secure your connection. STARTTLS upgrades an existing insecure connection to a secure one using TLS (Transport Layer Security). This is often used for email protocols like SMTP, IMAP, and POP3. Trusted Mail Servers: List trusted servers in case SSL or Start-TLS is enabled. Takes a comma-separated list as input. Authentication Type: Select the type of authentication for connecting to your IMAP Server. Currently, only BASIC is supported. Basic Auth The basic authentication method uses a username and password to authenticate to the server. Username: The username is the email address associated with your IMAP server. Password: Password is the password associated with your email address. Some email domains like Gmail do not allow using your email password but require you to use an application password for authentication. Email with MFA or 2FA also requires this. Actions  Actions Description Get email Get email using IMAP List emails from a specific folder List emails from a specific folder using IMAP Move email from one folder to another Move email from one folder to another using IMAP

Effortlessly review & monitor your automation’s performance

Overview Preview of the automation enables users to effortlessly review and understand their automation setup. It provides a comprehensive overview, including the number of successful and failed runs, the type of trigger, the apps used, last updated by and recent activity. It enables users to monitor the success and failure of each step, ensuring efficient automation processing and prompt issue resolution. Key Features Run Summary: Instantly see the number of successful and failed runs. Trigger Type: Identify the type of trigger that initiates the automation. Apps Used: View the applications involved in the automation. Creation and Last Updated Dates: Know when the automation was created and last modified. Recent Activities: All the updates made to the automation are logged in the activity section. Navigation: Easily navigate through the preview to understand the automation and logic of your automation. Run Summary It provides the status of the automation whether it is running or paused. Along with this it provides the user with the number of successful and failed runs for that particular automation. Trigger Type It lets you know the type of trigger being used in the automation. Whether it is callable, scheduler, webhook, or any application(such as Amazon S3, Salesforce, etc)  Apps Used It provides the visual representation (Logos) of the applications involved in the automation. Created and Last Updated Dates Created by: It shows the user who created the automation and the date and time of creation. Last modified by: It shows the user who last modified the automation and the date and time of the last modification. Recent Activity Activity Log: Displays recent activities related to the automation, including deployments and modifications. Users will be navigated to the activity tab if you want to drill down on any specific activity.  Node level Preview If you want to understand the node-level configuration of the automation, then you can click on the specific node to view the specification of the node in the third pane view. Each node prominently displays three key components: Input: The Input section reveals the parameters and configurations specified during the automation setup.  Output: The Output section provides the data structure of the output corresponding to the action selected. Details/Connection Details: In the case of an application node, the Connection Details section outlines the following attributes: In the case of an Internal node, the detail section outlines the following attributes: The Name of the application (Internal Node) The Action selected for the application.

Integrate your app with QuickBooks to streamline accounting, automate invoicing, and manage finances effortlessly

QuickBooks is a popular accounting software designed to help businesses manage finances, including invoicing, payroll, and expense tracking. It offers automation, cloud accessibility, and integration with other tools to streamline financial operations. Integrating QuickBooks streamlines financial management by automating tasks like invoicing, expense tracking, and reporting, saving time and reducing errors. Authentication Before you begin, make sure you have the following information: Connection Name: Select a descriptive name for your connection, like "MyAppQuickBooksIntegration". This helps in easily identifying the connection within your application or integration settings. Client ID: Enter the Client ID provided by the service you are connecting to. Client Secret: Enter the Client Secret associated with your Client ID. How to obtain Client ID and Client Secret? Follow these steps to obtain them: Go to the Intuit Developer Dashboard and sign in. From the Dashboard, click 'Create an App' or select an existing app. In the app menu, select 'Keys & Credentials'. Here, you will find your Client ID and Client Secret under either Development or Production. After obtaining your Client ID and Secret, follow these steps to set the Redirect URI: Go to the 'Settings' tab in the left-hand menu. Select 'Redirect URIs'. Add your Redirect URI (e.g., the URL where OAuth 2.0 will send the authorization code) and click 'Save'. Actions Actions Description Create a Bill Creates a bill in QuickBooks. Create a Bill Payment Creates a bill payment in QuickBooks. Create a Customer Creates a customer record in QuickBooks. Create a Payment Creates a payment in QuickBooks. Create a Purchase Creates a purchase transaction in QuickBooks. Create an Employee Creates an employee record in QuickBooks. Create an Estimate Creates an estimate in QuickBooks. Create an Invoice Creates an invoice in QuickBooks. Delete a Bill Deletes a bill by its ID in QuickBooks. Delete a Bill Payment Deletes a bill payment by its ID in QuickBooks. Delete a Payment Deletes a payment by its ID in QuickBooks. Delete a Purchase Deletes a purchase by its ID in QuickBooks. Delete an Invoice Deletes an invoice by its ID in QuickBooks. Get a Customer Retrieves customer details by ID in QuickBooks. Get a Payment Retrieves payment details by ID in QuickBooks. Get a Payment as PDF Retrieves a payment as a PDF by its ID in QuickBooks. Get an Employee Retrieves an employee by its ID in QuickBooks. Get an Estimate Details Retrieves the details of an estimate by its ID in QuickBooks. Get an Invoice as PDF Retrieves an invoice as a PDF by its ID in QuickBooks. Get an Invoice Details Retrieves the details of an invoice by its ID in QuickBooks. Query a Bill Queries a bill by its ID in QuickBooks. Read a Bill Reads the details of a bill by its ID in QuickBooks. Read a Bill Payment Reads the details of a bill payment by its ID in QuickBooks. Read a Purchase Reads the details of a purchase by its ID in QuickBooks. Update a Bill Updates the details of a bill by its ID in QuickBooks. Update a Bill Payment Updates the details of a bill payment by its ID in QuickBooks. Update a Customer Updates the details of a customer by its ID in QuickBooks. Update a Payment Updates the details of a payment by its ID in QuickBooks. Update a Purchase Updates the details of a purchase by its ID in QuickBooks. Update an Employee Updates the details of an employee by its ID in QuickBooks. Update an Estimate Updates an estimate by its ID in QuickBooks. Update an Invoice Updates an invoice by its ID in QuickBooks. Triggers Triggers Description New Record Triggers when a create, update, delete, or email operation is performed on entities such as estimates, vendors, invoices, bills, and more in QuickBooks.

Connect your app with FTP/FTPS to automate secure file transfers and streamline data exchange across systems.

Integrating your application with FTP/FTPS (File Transfer Protocol / File Transfer Protocol Secure) provides a standard method for transferring files between systems. While FTP offers basic file transfer capabilities, FTPS adds an encryption layer, enhancing security. Users can upload, download, and manage files on remote servers using command-line tools and graphical interfaces.  Authentication Before you begin, make sure you have the following information: Connection Name: Choose a descriptive name for your connection. This helps you easily identify the connection within your application or integration settings, such as "MyAppFTPIntegration". Authentication Type: Select the type of authentication for connecting to your FTP/FTPS server: Basic (Username and Password) SSL/TLS Certificates (for FTPS only) Basic Authentication Set Up FTP/FTPS User: Log into your server or hosting platform. Navigate to the FTP/FTPS settings or user management area. Create a new user account specifically for FTP/FTPS access. Assign necessary permissions and specify the home directory. Obtain the FTP/FTPS credentials (username and password). Connecting with an FTP/FTPS Client: Open an FTP client like FileZilla, Cyberduck, or WinSCP. Create a new connection profile and enter the following details: Host: The FTP/FTPS server address. Port: Use 21 for FTP or FTPS (explicit) and 990 for FTPS (implicit). Username and Password: Enter the credentials obtained in the previous step. For FTPS: Ensure SSL/TLS is enabled in the connection settings to secure the transfer. Connect to the server and start transferring files. SSL/TLS Certificates (FTPS Only) For secure FTPS connections using SSL/TLS, follow these additional steps: FTPS Type: Select the type of FTPS connection: Explicit FTPS: The connection starts as unencrypted FTP and upgrades to TLS/SSL upon an explicit request from the client. Implicit FTPS: The connection is encrypted from the beginning. Certificate Verification: Verify Certificate: Choose whether to verify the server’s SSL/TLS certificate. If required, enable trustAll to accept all certificates without verification (useful for testing environments or self-signed certificates). Actions Actions Description Delete file Deletes a file from the FTP/FTPS server Delete folder Deletes a folder from the FTP/FTPS server Download file Downloads a file from the FTP/FTPS server Get file information Gets information about a file from the FTP/FTPS server List files and directories Lists files and directories from the FTP/FTPS server Rename a file Renames a file on the FTP/FTPS server Search folder Searches for files and folders in a folder on the FTP/FTPS server Upload file Uploads a file to the FTP/FTPS server

Prevent infinite loops in bidirectional data synchronization by creating record hashes that ensure one-way data flow across connected systems.

Avoid Duplicate Operations allows UnifyApps data pipelines to prevent redundant processing of the same records when implementing cyclical or looped pipeline architectures. This setting creates unique hashes of records and actions to maintain data integrity and prevent duplicative operations during migration processes. Duplicate Prevention for Cyclical Pipeline Architectures When configured, UnifyApps implements a hash-based verification system that enables: One-way data flow even in bidirectional pipeline configurations Record-level duplicate detection for high-precision control Resource optimization by preventing redundant processing Configuring Avoid Duplicate Operations in Pipeline Settings To enable duplicate prevention in your UnifyApps data pipeline: Go to the Settings tab. Under the Avoid Duplicate Operations (Optional) section, check the box to enable the feature. Save your pipeline configuration. How Duplicate Prevention Works: Example Let's walk through a simple example to demonstrate how the duplicate prevention works during data synchronization: Example: Bidirectional Synchronization Between Systems Initial Configuration: Day 1 Oracle Database A contains customer records PostgreSQL Database B needs to maintain synchronized customer data Pipeline 1: Oracle → PostgreSQL Pipeline 2: PostgreSQL → Oracle (for updates made in PostgreSQL) Day 1: Without Duplicate Prevention Day 1: With Duplicate Prevention Enabled Day 3: Data Changes in Both Systems Two days later, records are updated independently in both systems: Updated Data: Oracle: Customer #1001 phone updated to 555-1234 PostgreSQL: Customer #1002 address updated to "123 Main St" Day 3: Synchronization with Duplicate Prevention Notice the key behaviors: Each record change is processed exactly once Changes flow properly in both directions Duplicate processing is avoided through hash verification Synchronization completes without infinite loops Practical Use Cases for Avoid Duplicate Operations Multi-System Data Synchronization When maintaining data consistency across multiple databases: Without duplicate prevention, a change in System A could ping-pong between systems indefinitely. Change Data Capture with Loopback Verification For CDC processes that include verification workflows: Master Data Management with Multiple Sources of Truth When combining multiple authoritative data sources: Changes from both systems flow into the hub without creating duplicate updates. ETL Processes with Validation Loops For complex ETL workflows with validation steps: The final status update doesn't trigger re-extraction of the same records. By implementing the Avoid Duplicate Operations setting, you ensure data integrity across complex pipeline architectures while preventing the resource waste and potential data corruption caused by infinite processing loops. This feature is especially crucial for bidirectional synchronization scenarios or any data pipeline implementation that might create circular data flows.

Enable users to refine, search, and sort data effortlessly across dashboards and datasets

Overview Filters help end users refine information on dashboard, stats and charts, to quickly show exactly what they need by selecting date ranges, or choosing particular categories of information across multiple data sources simultaneously. Standard Actions Following are the standard actions provided in Filter Components.  Date Filter: A date filter allows users to limit data based on specific time periods. It’s particularly useful for Dashboards which display Statistics that change over time. Features Range Selection : Users can set a start and end date to filter data within a specific period. Presets : Common time frames (e.g., "Last 7 days," "This Month," "Last Year") enable faster data exploration. You can also define a custom time range to be used as a default preset. Configuring Date filter For Analytics By UnifyApps: Set the start time, end time, previous start time and previous end time for the date fields from the ‘Date time filter’ object. For Storage By UnifyApps: Select the date fields (Created time/modified time/ any custom field) and add operators as required. For example, if you want to filter out records on the basis of created time, ‘created time’ greater than or equal to start time and  ‘created time’ less than or equal to end time. Sort: Organizes data in a specific order, allowing users to view information according to their preference. Features Ordering of Data : Data can be sorted either in ascending order or descending order of selected field. Users can also combine sorting of multiple fields in desired order to view the data. Initial Value : Users can also add a default sort to the Dataset using the initial value property. Configuring Sort Filter Set the sort property of your analytics or storage data source by selecting the sort array from the state of Filters Component. Search: The search bar allows the end user to filter out data by performing search operations using keywords or phrases.  Configuring Search Filter Select the fields you want the user to perform search operations on in your storage or analytics data source. Map the search input pill from the filters. Filter: This allows users to filter out data by performing operations on selected fields. Operators that can be applied to filterable fields: Field Type Operators String Field Contains, Equals to, Does not equal, Starts with, Ends with Boolean Field Is, Is not Number Field Less than, Less than or equal to, Greater than, Greater than or equal to, Equals to,  Does not equal Lookup Field Is, Is not Configuring Filter : Map the filter object from the input pills in your storage or analytics data source. Quick Filter Quick Filters allow users to apply pre-defined filters on their page components. You can customize quick filters using Data or Date filter types and select their value from the ‘Add Filter Value’ property. Field Filter Field Filters help users to filter out a single field and with specific operators. You can specify the field and operators to be shown for filtering. For example, you can select a string field type and only allow ‘Equals to’ operator. Setting Up Filterable Fields Using Aggregation Metadata The filter component works on the basis of aggregation metadata. This acts as a blueprint to decide the fields which are filterable, searchable or sortable. Only the fields included in the aggregation metadata will be displayed by the filter component. Stitching Filter Component with Data Sources You should include all relevant data sources on which the end user has to apply filtering, searching or sorting. When a data source is added to filters, it fetches the aggregation metadata directly when the data source is either storage or analytics. In Case The Data Source is Callable:  Create a separate data source for defining the aggregation metadata for configuring your Filter Component. Best Practices Data Source -  Your data source should ideally be storage or analytics as they can easily be filtered out. Date Filters - It is better to use Epoch timestamps. Filterable fields - Make sure you enable only those fields that are required by the users as there can be multiple fields with filters enabled by default such as ‘Created time’ and ‘Modified Time’. Labels - Always label your filter so that it appears more intuitive to users.

Integrate your app with Insided to enhance customer engagement, streamline community management, and drive self-service support.

Insided is a customer community platform that helps businesses engage users, foster discussions, and provide peer-to-peer support. It integrates with CRMs and support tools to enhance customer experience and self-service. Integrating your application with Insided (Gainsight’s Customer Communities) API enhances your community management capabilities by enabling advanced user management, content creation, and workflow automation.  Authentication Before you begin, make sure you have the following information: Connection Name: Choose a descriptive name for your connection (e.g. "MyAppInsidedIntegration") to easily identify it within your integration settings. Authentication Type: Insided API uses OAuth 2.0 for secure authentication and authorization. OAuth 2.0 Based Authentication Log in to your Control environment and navigate to Integrations  Navigate to API to create or manage your API credentials. For more details on available scopes, endpoint-specific parameters, and additional functionalities such as managing community content, users, and webhooks, please refer to the full Gainsight Customer Communities API Documentation. Actions Actions Description Search content Searches content in Insided Index content for search Indexes content for search in Insided Delete specific URLs Delete specific URLs from search in Insided Delete all content Delete all content from search in Insided

Reverse Polling technique efficiently retrieves recent data from APIs that return results in chronological order (oldest first), optimizing pagination and data processing strategies when working with time-ordered data sources.

Overview Reverse Polling is a specialized data retrieval pattern in UnifyApps Data Pipelines when working with API-based data sources that return results in chronological order (oldest records first). This approach requires specific handling techniques to efficiently process and extract the most recent or relevant data. What is Reverse Polling? When consuming data from external APIs, some services return data in chronological order by default (oldest to newest). In Reverse Polling, the system must traverse through the entire list to find the most recent records, which are positioned at the end rather than the beginning of the result set. Why It Matters? Understanding Reverse Polling helps data engineers and developers: Efficiently retrieve the most recent data when APIs present oldest records first Optimize data retrieval when only recent records are needed Implement proper pagination strategies for chronologically ordered APIs Reduce unnecessary data processing when only certain timeframes are relevant Technical Details When an API returns data in chronological order (oldest first), the system must: Process the entire list to reach the newest records Implement efficient lookup mechanisms to find specific timestamps or IDs Use appropriate pagination parameters to navigate forward in time Optimize queries to potentially skip earlier pages when only recent data is needed Implementation Considerations The UnifyApps platform handles these complexities behind the scenes by: Detecting API response ordering patterns Implementing optimized pagination strategies based on data ordering Using markers and indices to efficiently locate relevant data points Maintaining state information to optimize subsequent polling cycles Common API Examples APIs that commonly return data in oldest-first order include: Certain legacy database systems Some financial transaction APIs Log management systems Historical data services This knowledge article serves as background information for those interested in understanding the underlying concepts of API data retrieval patterns in UnifyApps Data Pipelines.

Connect your app with Facebook Ads to automate campaign management, optimize ad performance, and track marketing success.

Facebook Ads is a powerful advertising platform that enables businesses to reach targeted audiences based on demographics, interests, and behaviors. It offers a variety of ad formats to promote products, services, and brand awareness across Facebook, Instagram, and partner networks. Integrating your application with Facebook Ads streamlines campaign management, offering comprehensive tools for ad creation, performance tracking, and audience targeting, all while providing valuable insights to optimize your advertising strategy. Authentication Ensure you have the following information ready for a seamless integration process: Connection Name: Select a descriptive name for your connection, like 'MyAppFacebookAdsIntegration'. This helps easily identify the connection within your application or integration settings. Authentication Type: Facebook Ads supports token-based and OAuth authentication for server-to-server integrations. This allows admins to take actions within Facebook without user interference. OAuth Press the Authorize button. You'll be redirected to a Facebook sign-in page. If you're not already logged into Facebook, enter your Facebook account credentials. Facebook will display a permissions request screen. You'll see our app name and the specific services we request access to. Carefully review the permissions we're asking for. If you're comfortable with the permissions, click the "Allow" or "Grant Access" button. After granting access, you'll be automatically redirected back to our platform. You should see a confirmation message that your Facebook account is now connected. OAuth with Client Credentials Obtain your Facebook App's Client ID and Client Secret from the Facebook Developers Console. Enter these credentials in the designated fields in our platform: Client ID: Your Facebook application's unique identifier. Client Secret: Your application's secure authentication key. After entering valid credentials, the platform will establish a secure connection with your Facebook Ads account. You'll see a confirmation message once the connection is successfully established. Token Based Authentication Log into your Facebook Developers Console. Navigate to your App's settings. Go to the 'Tools & Support' section and select 'Graph API Explorer'. Click 'Generate Access Token'. Select the required permissions for Facebook Ads: ads_management ads_read business_management Copy the generated token. Paste the token into our platform's authentication field. The platform will validate the token and establish the connection. You'll receive a confirmation once the connection is successful. Actions Actions Description Create ad adset Creates an ad adset in Facebook Ads Create ad campaign Creates an ad campaign in Facebook Ads Delete adsets Deletes an adset in Facebook Ads Delete ad campaign Deletes an ad campaign in Facebook Ads Get Ads ID Gets ads ID in Facebook Ads Get Adset insights Gets Adset insights by ID in Facebook Ads Get Adset insights report Gets Adset insights report in Facebook Ads Get Adsets ID Gets Adsets ID in Facebook Ads Get Campaign Insights Gets campaign insights by campaign ID in Facebook Ads Get campaign ID Gets campaign ID in Facebook Ads Get campaign insights report Gets campaign insight report in Facebook Ads List Adsets Lists all ad sets related to a particular ad account in Facebook Ads List Campaigns Lists all campaigns related to a particular ad account in Facebook Ads Update  ad campaig  Updates an ad campaign in Facebook Ads

Create independent copies of your data fields to enable multiple mappings while preserving original values for validation and complex workflows.

Overview The Duplicate Field transformation creates an exact replica of an existing field as a new transient field with the same value. This powerful yet simple transformation serves as a foundation for complex data mapping and manipulation strategies without affecting your original data. Key Benefits Enable Multiple Mappings: Map the same data to multiple destination fields while preserving the original source Preserve Original Data: Maintain an unmodified copy while performing transformations on the duplicate Facilitate Validation: Keep original values for comparison and verification against transformed data How to Apply a Duplicate Field Transformation? Navigate to the transformation panel in your data pipeline Select "Duplicate Field" from the available transformations Specify a clear, descriptive name for the new transient field Click "Save" to apply the transformation. Implementation Example Best Practices Use Descriptive Naming: Choose names that clearly indicate the duplicate field's purpose (e.g., original_field_for_validation) Document Data Lineage: Maintain records of duplicated fields to easily trace data flow Consider Performance: While duplicating fields has minimal performance impact, extensive duplication may affect memory usage in large datasets Audit Field Usage: Regularly review duplicate fields to ensure they remain necessary to your data pipeline.

Integrate your app with Gainsight to enhance customer success, automate engagement workflows, and drive retention

Gainsight is a customer success platform that helps businesses drive retention, reduce churn, and maximize customer growth through data-driven insights and automation. It offers tools for customer health monitoring, engagement, and lifecycle management. Integrating Gainsight enhances customer retention, reduces churn, and drives growth through data-driven insights and automation.  Authentication Before you begin, make sure you have the following information: Connection Name: Choose a descriptive name for your connection (e.g. "MyAppGainsightIntegration") to easily identify it within your integration settings. Authentication Type: Gainsight API uses OAuth 2.0 for secure authentication and authorization. OAuth 2.0 Based Authentication Log in to your Control environment and navigate to Integrations  Navigate to API to create or manage your API credentials. For more details on available scopes, endpoint-specific parameters, and additional functionalities such as managing community content, users, and webhooks, please refer to the full Gainsight Customer Communities API Documentation Actions Actions Description Create company records Create a single or multiple company records in Gainsight NXT Create company team record Creates a company team record in Gainsight NXT Delete records Delete a specific record in the company object in Gainsight NXT Get team record details Retrieve the details of a team record in Gainsight NXT Search records Retrieve the details of records in Gainsight NXT Update company records Update company records in Gainsight NXT Update company team record Updates a company team record in Gainsight NXT Upsert person Upsert a single person in Gainsight NXT Upsert persons in bulk Upsert persons in bulk in Gainsight NXT

Integrate your app with Simplesat to collect real-time customer feedback, measure satisfaction, and improve service quality.

Simplesat is a customer feedback platform designed for service teams to easily collect, manage, and showcase client satisfaction data. It integrates with major help desks and CRMs to capture real-time feedback through CSAT, CES, and NPS surveys. Integrating Simplesat helps teams improve service quality by capturing actionable customer insights seamlessly. Authentication Before you begin, make sure you have the following information: Connection Name: Select a descriptive name for your connection, like "MyAppSimplesatIntegration". This helps in easily identifying the connection within your application or integration settings. Authentication Type: Simplesat supports API tokens for authentication.  API Key Based Authentication Sign up or log in to your Simplesat account by visiting the Simplesat dashboard. Navigate to the  API Key section by  clicking on your setting icon and selecting 'Account settings' from the dropdown menu. Your API Key is in the Account Key dropdown. Copy the generated API Key and store it securely to prevent unauthorized access. Actions Actions Description Find customer Finds a customer in Simplesat Find response Finds a response in Simplesat Find team member Finds a team member in Simplesat Upsert customer Upserts a customer in Simplesat Upsert response Upserts a response in Simplesat Upsert team member Upserts a team member in Simplesat Triggers Triggers Description New feedback Triggers when a new feedback is added in Simplesat

Integrate your app with Livestorm to streamline webinar hosting, automate event management, and enhance audience engagement.

Livestorm is a browser-based webinar and video conferencing platform designed for businesses to host live, on-demand, and automated events. It offers engagement tools, analytics, and integrations to enhance audience interaction and marketing efforts. Integrating Livestorm with your application enhances webinar management, audience engagement, and overall event effectiveness. Authentication Before integrating Livestorm, ensure you have the following information: Connection Name: Choose a descriptive name for your Livestorm connection to help identify it within your application or integration settings. A meaningful name, like "MyAppLivestormIntegration," helps maintain organization, especially when managing multiple integrations. Authentication Type: Livestorm provides you with only API key type of authentication. API Key Based Authentication Log in to your Livestorm account. Navigate to the "Account Settings" section in your account dashboard. Now, navigate to the "Public API" tab. Generate a new API key if one does not already exist. Copy the API key and store it securely as it provides access to your Livestorm account. Actions Actions Description Create event Creates a new event in Livestorm Create registrant Registers someone for a specific event session in Livestorm Create session Schedules a new session to the event in Livestorm Find people Find participants or team members in Livestorm Find session Finds an existing session in Livestorm Remove event Removes an event along with all its sessions in Livestorm Remove session Cancels or removes an event session from Livestorm Remove session registrant Removes a session registrant in Livestorm Update event Updates an existing event in Livestorm Update session Updates an event session in Livestorm Triggers Triggers Description Registrant attended Triggers when a registrant attended an event session that just ended (Livestorm) Registrant created Triggers when a new participant registers for an event session (Livestorm) Registrant not attended Triggers when a registrant didn't attend an event session that just ended (Livestorm) Registrant watched replay Triggers when a registrant has watched a replay of an event session (Livestorm) Session created Triggers when a session is created (Livestorm) Session ended Triggers when an event session ends (Livestorm) Session started Triggers when an event session starts (Livestorm)

Instantly leverage 30+ pre-built application connectors to extract, transform, and load your business-critical data between systems with UnifyApps' no-code integration platform.

Application connectors in UnifyApps serve as the backbone for seamless SaaS integration solutions. These connectors enable your organization to extract data from various cloud applications, transform it according to your business requirements, and load it into your destination platforms without complex coding or maintenance overhead. What Are Application Connectors? Application connectors are pre-built integration components that establish secure, reliable connections between UnifyApps and your SaaS applications. They handle the complexities of API communication, authentication mechanisms, rate limiting, and data schema transformations. Connection Methods UnifyApps application connectors support multiple authentication methods to ensure secure and flexible connectivity: OAuth 2.0 Industry-standard authorization framework Secure delegated access without sharing credentials Automatic token refresh capabilities Supported by most modern SaaS platforms (Salesforce, Google Apps, Microsoft 365) API Token/Key Authentication Simple authentication using application-generated tokens Long-lived access credentials Commonly used for service-to-service integrations Supported by platforms like Jira, HubSpot, Zendesk Basic Authentication Username/password-based authentication Typically used for legacy systems Secure transmission via HTTPS JWT (JSON Web Tokens) Self-contained authentication method Digitally signed tokens with claims Used by platforms like ServiceNow and some custom implementations Polling Methods UnifyApps implements various polling strategies to efficiently retrieve data from source applications: Forward Polling Retrieval starting from most recent records backward Example: Getting latest Zendesk tickets first Optimal for prioritizing recent data in time-sensitive scenarios Reverse Polling Sequential data retrieval based on timestamp or ID Example: Fetching Salesforce records created after last sync time Efficient for applications with chronological data creation Cursor-Based Polling Uses application-provided pagination cursors Example: Facebook Ads' cursor pagination Highly efficient for large datasets Resilient to data changes during polling Webhook-Based Ingestion Real-time data capture via push notifications Example: Shopify order webhooks Minimizes latency and reduces API load Complementary to polling strategies Supported Application Connectors UnifyApps offers native connectivity to a comprehensive range of SaaS platforms: Application Connector Description Common Use Cases Airtable Collaborative spreadsheet-database Project management, content calendars Facebook Ads Social media advertising platform Marketing analytics, ad performance Google Ads Online advertising platform Campaign tracking, conversion analysis Google Analytics Web analytics service Website performance, user behavior Google Sheets Cloud-based spreadsheet Collaborative data management, reporting HubSpot CRM and marketing platform Lead management, marketing automation Jira Project management tool Development tracking, issue management Klaviyo Marketing automation platform Email campaigns, customer segmentation LinkedIn Marketing B2B marketing platform Professional audience targeting, ads Mailchimp Email marketing platform Newsletter campaigns, subscriber analytics Microsoft Dynamics 365 CRM Business applications suite Customer relationship management Mixpanel Product analytics platform User engagement, feature adoption Monday Project management platform Team collaboration, workflow management Omnisend E-commerce marketing platform Customer journey automation QuickBooks Accounting software Financial data, bookkeeping Recharge Subscription payment management Recurring billing, subscriber analytics Salesforce CRM platform Sales pipeline, customer data ServiceNow IT service management Workflow automation, service desk Shopify E-commerce platform Order data, product inventory Workday HR management system Employee data, organizational structure Workiva Financial reporting platform Compliance reporting, disclosure management Zendesk Customer service platform Support tickets, customer interactions Destination Support UnifyApps also supports writing data to several application/SaaS connectors, enabling bi-directional data flows: Microsoft Dynamics 365 CRM Salesforce Tableau Zendesk Key Features of Application Connectors All UnifyApps application connectors share common capabilities that enable efficient and secure data integration: Intelligent Rate Limiting Automatic API quota management Backoff and retry mechanisms Quota distribution optimization Schema Discovery Automatic metadata retrieval Field-level mapping capabilities Custom field support Comprehensive Object Support Access to standard and custom objects Relationship traversal capabilities Support for nested data structures Multiple Ingestion Modes Historical and Live: Full load plus ongoing changes Live Only: New data from deployment onward Historical Only: One-time full load Data Transformation Field mapping and conversion Filtering capabilities Formula-based derived fields Business Benefits Application connectors deliver significant value to your organization by: Accelerating Time-to-Value: Implement integrations in days instead of months Reducing Maintenance Burden: Automatic adaptation to API changes Breaking Down Data Silos: Connect data across your application landscape Enabling Real-Time Operations: Synchronize data with minimal latency Supporting Business Agility: Quickly adapt to new applications and requirements

Connect to Snowflake for fast, scalable cloud data warehousing and analytics

Integrating your application with Snowflake transforms your data warehousing and analytics capabilities, offering a cloud-native platform for scalable, flexible, and high-performance data processing. Connecting your application to a Snowflake account allows you to interact with Snowflake's data warehousing capabilities directly from your application. Authentication Before you begin, make sure you have the following information: Connection Name: Select a descriptive name for your Snowflake connection. This identifier will help you recognize the connection within your application or integration settings. For example, you might choose something like "MyAppSnowflakeDataWarehouse" Account Identifier: This is your unique Snowflake account locator. To find this, click on "admin" in the Snowflake interface, then click on "your accounts." Hover over the "locator" field, and you'll see the Account Identifier displayed as something like abc12345.region.snowflakecomputing.com. Client ID and Secret: Fetch the Client ID and Secret for your Snowflake account basis this documentation. Warehouse Name: It is the compute resource that executes SQL queries. To view your warehouses, go to the left sidebar and click "Admin" then click "Warehouses". Here, you'll see a list of warehouse names and their details. Database Name: It is another crucial piece of information. This is the container for your schemas and tables. To view your databases, go to the left sidebar and click "Data" then click "Databases". You'll see a list of all available databases. Schema Name: To view schemas, first select a database, then click "Schemas" within that database. You'll see a list of all schemas in the selected database. Actions Action Description Delete rows Deletes rows in a table using Snowflake Execute SQL Executes SQL in Snowflake Insert a row Inserts a row in a table in Snowflake Replicate batch rows Replicates a batch of rows to a table in Snowflake Select rows Selects rows from a table in Snowflake

Integrate your app with Pipeline CRM to streamline sales processes, automate lead management, and enhance customer relationships

Pipeline CRM is a sales-focused customer relationship management (CRM) tool designed to help teams track leads, manage deals, and streamline workflows. It offers automation, reporting, and integrations to improve sales efficiency. Connecting your application to a Pipeline CRM account allows you to interact with Pipeline CRM's contact management, deal tracking, and reporting features directly from your application.  Authentication Before you begin, make sure you have the following information: Connection Name: Choose a descriptive name for your Pipeline CRM connection to help identify it within your application or integration settings. A meaningful name, like "MyAppPipelineCRMIntegration," helps maintain organization, especially when managing multiple integrations. App Key: The API key is required for both JWT and API based authentication. Authentication Type: Select the type of authentication for connecting to your Pipeline CRM account: JWT based Authentication API Token based Authentication App key Log into your Pipeline account and go to settings. Go to API Integrations and click on Add Integration Enter the required details and select the required authentication type and the expiry time of JWT to create the api integration and get the app key. Store this key securely to prevent unauthorised access. JWT Based Authentication  Enter your username or email that you use to login into your Pipeline CRM account.  Enter the password that you use to login into your Pipeline CRM account.  Enter the MFA code if your Pipeline CRM account is MFA protected. API Token Based Authentication Go to the API integrations page as before and now go to the API keys tab. Now enable the API access and copy the API token and store it securely, as it allows access to your Pipeline CRM account. Actions Actions Description Create activity Creates a new activity associated with an existing person, company, or deal in Pipeline CRM. Create company Creates a new company in Pipeline CRM. Create deal Creates a new deal in Pipeline CRM. Create person Creates a new person in Pipeline CRM. Create task Creates a new calendar task in Pipeline CRM. Find company Finds an existing company in Pipeline CRM. Find deal Finds an existing deal in Pipeline CRM. Find person Finds an existing person in Pipeline CRM. Find user Finds an existing user in Pipeline CRM. Update company Updates an existing company in Pipeline CRM. Update deal Updates an existing deal in Pipeline CRM. Update person Updates an existing person in Pipeline CRM. Triggers Triggers Description Deal created Triggers when a deal is created on Pipeline CRM. Deal updated Triggers when a deal is updated on Pipeline CRM. Person created Triggers when a person is created on Pipeline CRM.