# Getting Started


--------------------------------------------------------------------------------
title: "Introduction to Catalyst"
description: "Learn about Zoho&#39;s flagship, pro-code, serverless platform, Catalyst, built on top of world-class, tried-and-tested infrastructure that assits in you creating highly-scalable, remarkable solutions through disruptive innovation"
last_updated: "2026-03-18T07:41:08.553Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/introduction-to-catalyst/"
service: "All Services"
--------------------------------------------------------------------------------

 
# Introduction to Catalyst by Zoho

### Overview

Catalyst by Zoho is a full stack, cloud-based, scalable platform that provides developer functionalities to build software services and applications of any scale in various programming environments. You can build solutions ranging from simple microservices and independent software modules to interactive and dynamic cloud apps, enterprise software, robust business suites, and more for an array of industry verticals, use cases, and requirements. Catalyst is backed by Zoho&#39;s powerful, resilient, tried-and-tested infrastructure that ensures the solutions you build are consistent, reliable, and efficient in their performance, and are highly secure.

Catalyst powers you by providing a host of features through various services, all aimed at providing comprehensive end-to-end support throughout the application building process. You benefit from a platform that offers you the precise tools required to optimize your development, deployment, and post-production phases, enabling you to produce effective business solutions. These server-side programmable services are all available in a unified, accessible, user-friendly interface in a cloud console.


With Catalyst, you get to build solutions in a cost-effective manner by selecting between two different pricing models (a Subscription model or a Pay-as-you-go model) based on your business requirements and usage. You can also utilize free-tiers and benefits that enable you to work with Catalyst for free of cost until you exceed the hard limits imposed on these benefits. This, along with a serverless infrastructure, facilitates optimal cost efficiency with zero downtime.

Ultimately, Catalyst is designed to allow programmers to focus more on designing the user experience and business logic of their serverless applications and solutions, instead of investing time and effort into setting up and maintaining the server-side components. Developers don&#39;t need to build and manage servers or storage solutions manually, or worry about the infrastructure their applications are built on.

You can avail various development tools such as ready-to-use SDKs for a supported programming environment of your choice or RESTful APIs to access various Catalyst components and functionalities. You can also choose to build with Catalyst from your local enviroment with Catalyst CLI, and deploy them to cloud when needed. These developer tools help you customize the already functional server-side behavior to your needs, build on the ready-made components, and seamlessly integrate these backend features into your solutions. Catalyst therefore presents a significantly faster, hassle-free, and cost-effective software development experience.


### Catalyst Services

Catalyst by Zoho offers the following services:

1. {{%link href=&#34;/en/serverless/&#34;%}}**Catalyst Serverless:**{{%/link%}} Catalyst Serverless is a fully-managed, cloud-computing platform that provides a powerful infrastructure for your application building needs. Catalyst Serverless provides FaaS and PaaS solutions, and supports multiple programming environments.

2. {{%link href=&#34;/en/cloud-scale/&#34;%}}**Catalyst Cloud Scale:**{{%/link%}} Catalyst Cloud Scale includes components that enable you to securely build and host robust serverless applications and microservices. You can access end-to-end solutions for your application storage, security, integration, and deployment needs.

3. {{%link href=&#34;/en/zia-services/&#34;%}}**Catalyst Zia Services:**{{%/link%}} Catalyst Zia Services offer a host of ML and AI-powered microservices that you can readily incorporate in the programming environment of your choice. Catalyst Zia services includes features like OCR, AutoML, Text Analytics, Image Moderation, and more.

4. {{%link href=&#34;/en/devops/&#34;%}}**Catalyst DevOps:**{{%/link%}} Catalyst DevOps enables you to implement a DevOps model in your software building process. This provides components that allow you to operate your code at scale, and perform application monitoring, iterative testing, and quality checks with ease.

5. {{%link href=&#34;/en/smartbrowz/&#34;%}}**Catalyst SmartBrowz:**{{%/link%}} Catalyst SmartBrowz allows you to configure and access a headless browser programmatically using popular browser automation libraries. You can crawl and scrape permitted websites, and design templates with dynamic content to generate visual documents of them.

6. {{%link href=&#34;/en/quickml/&#34;%}}**Catalyst QuickML:**{{%/link%}} Catalyst QuickML allows you to create machine-learning pipelines with end-to-end solutions in a fully no-code ML pipeline builder service. You can access a host of pre-built ML algorithms, operations, and data preprocessing techniques, and connect with datasets to build ML models.

7. {{%link href=&#34;/en/convokraft/&#34;%}}**Catalyst ConvoKraft:**{{%/link%}} Catalyst ConvoKraft enables you to build textbased conversational bots that can be embedded into your Catalyst solutions. You can configure tasks for your bot and define the underlying business logic to govern its actions.


### Supported Environments

You can develop web and mobile applications using Catalyst and utilize the following SDKs for your needs:

1. {{%link href=&#34;/en/sdk/web/v4/overview/&#34; %}}Web{{%/link%}}
2. {{%link href=&#34;/en/sdk/android/v2/overview/&#34; %}}Android{{%/link%}}
3. {{%link href=&#34;/en/sdk/ios/v2/overview/&#34; %}}iOS{{%/link%}}
4. {{%link href=&#34;/en/sdk/flutter/v2/overview/&#34; %}}Flutter{{%/link%}}

### Supported Programming Languages and Frameworks

You can develop serverless functions in the following programming languages and frameworks:

1. {{%link href=&#34;/en/sdk/java/v1/overview/&#34; %}}Java{{%/link%}}
2. {{%link href=&#34;/en/sdk/nodejs/v2/overview/&#34; %}}Node.js{{%/link%}}
3. {{%link href=&#34;/en/sdk/python/v1/overview/&#34; %}}Python{{%/link%}}

--------------------------------------------------------------------------------
title: "Quick Start Guide"
description: "The Quick Start Guide teaches you the basics of developing an application or a microservice in Catalyst and familiarizes you with setting up your work environment in under ten minutes"
last_updated: "2026-03-18T07:41:08.554Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/quick-start-guide/"
service: "All Services"
--------------------------------------------------------------------------------


# Quick Start Guide

This quick start guide will familiarize you with setting up the Catalyst work environment in under ten minutes. With
this guide, you can quickly learn the basic steps involved in developing a Catalyst application in a generic way, with the most popular services.

**You can access detailed step-by-step tutorials on building applications and microservices involving different
Catalyst services and components from {{%link href=&#34;/en/tutorials/&#34; %}}the Tutorials
section{{%/link%}}.**

{{%bold%}}{{%link href=&#34;/en/&#34; %}}Access all Catalyst resources{{%/link%}}{{%/bold%}} and
check out the various help resources available.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Refer to the links provided in this guide for detailed help on various
topics.{{%/note%}}

&lt;div class=&#34;wrapper&#34;&gt;&lt;iframe allow=&#34;accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture&#34; allowfullscreen=&#34;&#34; frameborder=&#34;0&#34; height=&#34;315&#34; src=&#34;https://www.youtube-nocookie.com/embed/Dj9LMG6IPxE&#34; title=&#34;YouTube video player&#34; width=&#34;650&#34;&gt;&lt;/iframe&gt;&lt;/div&gt;

### Prerequisites

1. {{%link href=&#34;https://nodejs.org/en/download/&#34; %}}Node.js and NPM{{%/link%}} for your platform to install Catalyst
CLI and to develop Node.js functions
2. {{%link href=&#34;https://www.oracle.com/technetwork/java/javase/downloads/index.html&#34; %}}Java SE Development
Kit{{%/link%}} to develop Java functions
3. {{%link href=&#34;https://www.python.org/&#34; %}}Python{{%/link%}} for your platform to develop Python functions
4. Any IDE tool for coding the
{{%link href=&#34;/en/cli/v1/project-directory-structure/client-directory/&#34; %}}client{{%/link%}}, 
{{%link href=&#34;/en/cli/v1/project-directory-structure/functions-directory/&#34; %}}functions{{%/link%}}, or {{%link href=&#34;/en/serverless/help/appsail/introduction/&#34; %}}AppSail{{%/link%}}.

&lt;br&gt;

### Step 1: Create a Catalyst project

The first step in developing a Catalyst application is to {{%link href=&#34;/en/getting-started/catalyst-projects/&#34; %}}create a Catalyst project{{%/link%}} for it.

1. Log in to the Catalyst console and click {{%bold%}}Create a new Project{{%/bold%}}.
2. Enter the project&#39;s name in the pop-up window.
3. Click {{%bold%}}Access Project{{%/bold%}} to open it.

You can now set up and work with the Catalyst services and components from the console. Refer to each service&#39;s index page from the {{%link href=&#34;/en/&#34; %}}help resources{{%/link%}} to learn about it and the components in detail.

&lt;br&gt;

### Step 2: Install Catalyst CLI

{{%link href=&#34;/en/getting-started/installing-catalyst-cli/&#34; %}}Install Catalyst CLI{{%/link%}} to develop, test, and deploy Catalyst applications from your local system.

Execute this command in your terminal:

{{%cli%}} npm install -g zcatalyst-cli{{%/cli%}}

Execute this command to verify if the CLI is properly installed:

{{%cli%}} catalyst --version{{%/cli%}}&lt;br/&gt;


{{%note%}}{{%bold%}}Note:{{%/bold%}} If you are unable to install Catalyst CLI, execute the install command using {{%badge%}}sudo{{%/badge%}}.{{%/note%}}

You will now be able to access the {{%badge%}}{{%bold%}}catalyst{{%/bold%}}{{%/badge%}} command from your terminal. Refer to the {{%link href=&#34;/en/cli/v1/cli-command-reference/&#34; %}}**CLI help resources**{{%/link%}} for detailed help with the CLI commands and actions.

&lt;br&gt;

### Step 3: Log in from your CLI

1. Execute this command to {{%link href=&#34;/en/cli/v1/login/login-from-cli/&#34; %}}log in to your Zoho account{{%/link%}} from the CLI:&lt;br /&gt;

{{%cli%}} catalyst login{{%/cli%}}

2. Press {{%bold%}}Y{{%/bold%}} to allow Catalyst to collect CLI error reports and press {{%bold%}}Enter{{%/bold%}}.

3. Sign in using your credentials in the Zoho accounts login page.

4. Click {{%bold%}}Accept{{%/bold%}} to provide data access permissions to the CLI.

5. Close the browser window and continue using the CLI in your terminal.

&lt;br&gt;

### Step 4: Initialize the project from the CLI

1. Create a folder for the project on your local machine and navigate to it from the terminal.
2. Execute this command from that directory to {{%link href=&#34;/en/cli/v1/initialize-resources/introduction/&#34; %}}initialize a Catalyst project{{%/link%}} in it:&lt;br /&gt;

{{%cli%}} catalyst init{{%/cli%}}&lt;br/&gt;

{{%note%}}{{%bold%}}Note:{{%/bold%}} The first Catalyst project can only be created from the web console, and not from the CLI. However, you can create subsequent projects directly from the CLI.{{%/note%}}

3. Select the components that you need to set up for your Catalyst application and press {{%bold%}}Enter{{%/bold%}}. You can initialize Serverless {{%link href=&#34;/en/serverless/help/functions/introduction/&#34; %}}functions{{%/link%}} and CloudScale client.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can also initialize Serverless {{%link href=&#34;/en/serverless/help/appsail/introduction/&#34;%}}AppSail{{%/link%}} and deploy your app&#39;s build files onto the PaaS.{{%/note%}}

4. Associate the directory with a Catalyst project by selecting a project from the list and press {{%bold%}}Enter{{%/bold%}}.

5. If you initialize a function, select a function type and the stack, and press {{%bold%}}Enter{{%/bold%}}. &lt;br /&gt;
   * If you initialize a Java function, provide the reference name and the main class name, then install the Catalyst Java SDK package.
   * If you initialize a Node.js function, provide the values for the package name, the entry point file name, and the author&#39;s email address. Install the dependencies when prompted.
   * If you initialize a Python function, provide the values for the package name and the entry point file name.

6. If you initialize the client, provide a name for the client package.

The components will be installed and the project directory will be set up with the necessary dependencies and configuration. Refer to the {{%link href=&#34;/en/cli/v1/project-directory-structure/introduction/&#34; %}}standard project directory structure help page{{%/link%}} for details.

&lt;br&gt;

### Step 5: Develop the application

You can now work with the components you initialized in your Catalyst project and use any IDE tool of your choice to code the functions or the client. Refer to the following help documentations for detailed help on working with the Catalyst SDK and API resources, and incorporating Catalyst components in your business logic:

* {{%link href=&#34;/en/sdk/java/v1/overview/&#34; %}}Java SDK help documentation{{%/link%}}
* {{%link href=&#34;/en/sdk/nodejs/v2/overview/&#34; %}}Node.js SDK help documentation{{%/link%}}
* {{%link href=&#34;/en/sdk/python/v1/overview/&#34; %}}Python SDK help documentation{{%/link%}}
* {{%link href=&#34;/en/sdk/web/v4/overview/&#34; %}}Web SDK help documentation{{%/link%}}
* {{%link href=&#34;/en/sdk/android/v2/overview/&#34; %}}Android SDK help documentation{{%/link%}}
* {{%link href=&#34;/en/sdk/ios/v2/overview/&#34; %}}iOS SDK help documentation{{%/link%}}
* {{%link href=&#34;/en/sdk/flutter/v2/overview/&#34; %}}Flutter SDK help documentation{{%/link%}}
* {{%link href=&#34;/en/api/introduction/overview-and-prerequisites/#OverviewandPrerequisites&#34; %}}API help documentation{{%/link%}}

&lt;br&gt;

### Step 6: Test the application locally

After you develop the Catalyst application or microservice, you can {{%link href=&#34;/en/cli/v1/serve-resources/introduction/&#34; %}}test it locally{{%/link%}} from the CLI before deploying it to the Catalyst web console.

Execute this command from your project directory:

{{%cli%}} catalyst serve{{%/cli%}}&lt;br/&gt;

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can also {{%link href=&#34;/en/cli/v1/working-with-functions/functions-shell/&#34; %}}launch an exclusive Node shell from the CLI{{%/link%}} to test the functions.{{%/note%}}

You can access the functions, client, and AppSail from its local URL displayed in the CLI, and test them.

&lt;br&gt;

### Step 7: Deploy the project

After you test the application, you can {{%link href=&#34;/en/cli/v1/deploy-resources/introduction/&#34; %}}deploy it to the remote console{{%/link%}} by executing this command from your project directory:

{{%cli%}}catalyst deploy{{%/cli%}}


Your application can now be accessed from its web app URL in the {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34; %}}Development environment{{%/link%}}. To access the application in the Production environment, you must set up {{%link href=&#34;/en/deployment-and-billing/billing/introduction/&#34; %}}Catalyst payments{{%/link%}} and {{%link href=&#34;/en/deployment-and-billing/environments/initial-deployment/&#34; %}}deploy the project to production{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can also host web applications directly from the console through {{%link href=&#34;/en/cloud-scale/help/web-client-hosting/introduction/&#34; %}}web client hosting{{%/link%}} or {{%link href=&#34;/en/serverless/help/functions/implementation/&#34; %}}upload function bundles{{%/link%}} in the console. You can host and distribute a mobile application using {{%link href=&#34;/en/cloud-scale/help/mobile-device-management/introduction/&#34; %}}Mobile Device Management{{%/link%}}.{{%/note%}}

{{%link href=&#34;/en/tutorials/&#34; %}}**Access Tutorials**{{%/link%}} to try out some sample applications.

--------------------------------------------------------------------------------
title: "Install Catalyst CLI"
description: "Catalyst CLI contains a set of tools that enable you to initialize projects, and develop, test, and deploy the components of your applications and microservices from your local machine."
last_updated: "2026-03-18T07:41:08.555Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/installing-catalyst-cli/"
service: "All Services"
--------------------------------------------------------------------------------


# Install Catalyst CLI

### Introduction

Catalyst CLI contains a set of tools that enable you to initialize projects, and develop, test, and deploy the
components of your applications and microservices from your local machine. The CLI includes commands and operations applicable to most Catalyst services, such as Cloud Scale, Serverless, or SmartBrowz. You can learn about the CLI commands available and access detailed help with the CLI from the {{%link href=&#34;/en/cli/v1/cli-command-reference/&#34; %}}**CLI Documentation**{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}} The CLI works with the development environment of your Catalyst project. Therefore, the activities that you perform using the CLI, such as creating a function or deploying a client to the
{{%link href=&#34;/en/getting-started/navigating-in-the-console/&#34; %}}remote console{{%/link%}}, are not reflected in the live production environment of the project. To enable them in the production environment of your application, you must {{%link href=&#34;/en/deployment-and-billing/environments/initial-deployment/&#34; %}}deploy your project{{%/link%}} to the production environment. {{%/note%}}

#### Supported OS:

* {{%bold%}}Windows{{%/bold%}}
* {{%bold%}}macOS{{%/bold%}}
* {{%bold%}}Linux{{%/bold%}}

You can install Catalyst CLI in any of the supported operating systems in the same way as discussed in this help page. Catalyst CLI offers the same CLI functionalities across all platforms. After you have installed Catalyst CLI, you can work with your Catalyst projects and build applications directly from your system&#39;s terminal.


### Pre-requisities

Before you install Catalyst CLI, you must have the following prerequisites installed in your system.

#### Node.js and Node Package Manager (NPM):

Catalyst CLI can be installed through NPM or the Yarn package manager.
&lt;br /&gt;&lt;br /&gt; 

You can therefore install NPM on your system to install the CLI directly, or install the Yarn package manager using NPM and then install the CLI with it.&lt;br /&gt;&lt;br /&gt; To check if you already have Node.js and NPM installed, execute the following commands in your terminal which display their installed versions, if present:&lt;br /&gt;

{{%cli%}}node -v{{%/cli%}}&lt;br/&gt;

{{%cli%}}npm -v{{%/cli%}}

&lt;br /&gt; If you don&#39;t have them installed, you can {{%link href=&#34;https://nodejs.org/en/download/&#34; %}}download Node.js{{%/link%}} for your platform from their official website, or use a Node version manager like NVM to install Node.js and NPM. NPM comes bundled with Node.js when you install it.&lt;br /&gt;&lt;br /&gt; Refer to the {{%link href=&#34;https://nodejs.org/en/docs/&#34; %}}Node.js help documentation{{%/link%}} or {{%link href=&#34;https://docs.npmjs.com/getting-started/installing-node&#34; %}}NPM documentation{{%/link%}} for further help.&lt;br /&gt;

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst CLI will only run on {{%bold%}}Node.js v14 or later{{%/bold%}}. Ensure that you install an appropriate version.{{%/note%}}

#### Programming Language Support:

 You can develop {{%link href=&#34;/en/serverless/help/functions/introduction/&#34; %}}server-side functions{{%/link%}} in the following language environments in Catalyst: 

   1. Node.js
   2. Java
   3. Python

Before you do so, you must ensure that you have installed all the required components of these language environments in your local system.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can install these programming language prerequisites only if you plan on intializing Catalyst functions from the CLI, and for the stacks you require.{{%/note%}}

Because you have installed Node.js in the previous step, the components required to develop Node.js functions will already be available in your system.

You can also manually install a supported runtime of Node.js and the corresponding supported SDK package to develop functions in that runtime.

&lt;br&gt;

{{%bold%}}Java:{{%/bold%}} To develop Java functions, install the relevant Java Development Kit (JDK) in your system for your platform. You must install:
* {{%link href=&#34;https://www.oracle.com/technetwork/java/javase/downloads/index.html&#34; %}}Version 8 of the Java Standard Edition (SE){{%/link%}} platform&#39;s JDK
* {{%link href=&#34;https://www.oracle.com/in/java/technologies/javase/jdk11-archive-downloads.html&#34; %}}Version 11 of the Java Standard Edition (SE){{%/link%}} platform&#39;s JDK
* {{%link href=&#34;https://www.oracle.com/java/technologies/downloads/#java17&#34; %}}Version 17 of the Java Standard Edition (SE){{%/link%}} platform&#39;s JDK

Refer to the {{%link href=&#34;https://docs.oracle.com/en/java/&#34; %}}JDK documentation{{%/link%}} for further help.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst currently only offers support for version {{%bold%}}8{{%/bold%}}, {{%bold%}}11{{%/bold%}}, and {{%bold%}}17{{%/bold%}} of the Java SE Development Kit. If you do not have the exact version installed in your machine, we recommend that you install the exact JDK for optimum performance.{{%/note%}}

&lt;br&gt;

{{%bold%}}Python:{{%/bold%}} To develop Python functions, install **Python version 3.9** from their {{%link href=&#34;https://www.python.org/&#34;%}}official website{{%/link%}} for your platform and the Python Package Manager, Pip. The {{%link href=&#34;https://pip.pypa.io/en/stable/installation/#&#34;%}}Pip package manager{{%/link%}} will be auto-installed in your local system if you install Python from their official source.

&lt;br&gt;

### Install the CLI

You must install Catalyst CLI in your system using the terminal in the administrator mode, as this command execution requires admin privileges. You can run the terminal as administrator in your Windows environment, or execute the installation command using {{%badge%}}{{%bold%}}sudo{{%/bold%}}{{%/badge%}} in a UNIX command like, such as in macOS or Linux systems.

You must execute the following command in your terminal to install Catalyst CLI:

{{%cli%}} npm install -g zcatalyst-cli{{%/cli%}}


If you are installing it through the {{%link href=&#34;https://yarnpkg.com/&#34; %}}Yarn package manager{{%/link%}}, execute the following command in your terminal:

{{%cli%}} yarn add zcatalyst-cli{{%/cli%}}

&lt;br /&gt;

This will initiate the installation process and your terminal will display the progress.


After the installation is complete, the CLI will display these details.


You can verify if the CLI was properly installed by executing the following command:

{{%cli%}} catalyst --version{{%/cli%}}

&lt;br /&gt;

If there were no issues with the installation, the command will return the version of the CLI installed in your system.

You will now be able to access the {{%badge%}}catalyst{{%/badge%}} command from your terminal.

You can refer to the {{%link href=&#34;/en/cli/v1/cli-command-reference/&#34; %}}**CLI documentation**{{%/link%}} from the Catalyst resources page for help with the CLI commands.

&lt;br&gt;

### Update Catalyst CLI to the Latest Version

When a newer version of the Catalyst CLI is available, your terminal will display a message alerting you of it, after you execute a CLI command successfully.

&lt;br /&gt;

To update your CLI, execute the following command in your terminal:

{{%cli%}} npm install -g zcatalyst-cli{{%/cli%}}

&lt;br /&gt;

This will initiate the installation process for the latest version.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* In some cases, your system&#39;s registry values might not reflect the latest version of Catalyst CLI. This might cause your system to retain the older version of the CLI. To avoid this, mention the version number while executing the command. For example, to update to the version 1.9.0, run {{%bold%}}$ {{%badge%}}npm install -g zcatalyst&lt;span&gt;&lt;/span&gt;-cli@1.9.0{{%/badge%}}{{%/bold%}}


* If you are unable to update Catalyst CLI, execute the command using {{%badge%}}{{%bold%}}sudo{{%/bold%}}{{%/badge%}}.
{{%/note%}}

&lt;br /&gt;

--------------------------------------------------------------------------------
title: "Catalyst Projects"
description: "The solutions you build on Catalyst are built as individual projects that you can create and work with from a remote console or using Catalyst CLI"
last_updated: "2026-03-18T07:41:08.555Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/catalyst-projects/"
service: "All Services"
--------------------------------------------------------------------------------


# Catalyst Projects

### The Index Page

You can begin your Catalyst application development from the Catalyst console. Sign in with your Zoho account or with your Catalyst account, if prompted to do so. You will then be redirected to this index page in the console.

Access the Catalyst console based on your Zoho account&#39;s data center (DC): {{%link href=&#34;https://console.catalyst.zoho.eu/baas/index&#34; %}}EU{{%/link%}}, {{%link href=&#34;https://console.catalyst.zoho.in/baas/index&#34; %}}IN{{%/link%}}, {{%link href=&#34;https://console.catalyst.zoho.com/baas/index&#34; %}}US and others{{%/link%}}. 

&lt;br /&gt;

The index page lists all Catalyst projects that you create in your Catalyst account, and enables you to create new projects. The {{%link href=&#34;/en/getting-started/navigating-in-the-console/#header&#34; %}}notifications and settings{{%/link%}} icons in the top-right corner display the notifications and {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/introduction/&#34; %}}general settings{{%/link%}} that are common to all your Catalyst projects. You can access the project-specific settings from inside a project. The index page also lists all the help resources for various services, development tools, and more.

&lt;br&gt;

### Introduction to Catalyst Projects

Before you begin working with Catalyst by creating a project, keep in mind the following points about Catalyst projects:

* Catalyst projects are not service-specific. You can access all Catalyst services and components within a project and build any solution of any scale or vertical such as web apps, microservices, enterprise solutions, and more.
* You can create one application of each platform in a single Catalyst project. That is, you can create one web app, one Android app, and one iOS app in a single Catalyst project. You can create multiple functions and AppSail solutions in a project.
* When you create a project, it is not platform-specific. You can download the {{%link href=&#34;/en/getting-started/catalyst-sdk/&#34; %}}SDK{{%/link%}} for a platform and include it in your business logic and application building process later. Catalyst also supports cross-platform development within a single project.
* All solutions in the same project can access the same backend data from the Catalyst services and components, such as CloudScale&#39;s Data Store and File Store, and Serverless Functions. The features configured in Catalyst apply to all solutions in the same project, and you can view common analytics data. This enables users to access the same data while switching between different platform versions of the app.
* If you intend to build different solutions that do not share the same data or functionalities between them, you can create individual projects for them.
* When you create a new project, a unique {{%badge%}}**Project ID**{{%/badge%}} will be generated for it. You can view it from the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings/&#34; %}}_General Settings_{{%/link%}} section.
* You can build and test solutions in your project in the development environment sandbox, then deploy them to production by {{%link href=&#34;/en/deployment-and-billing/environments/deployment-types/&#34; %}}deploying your project{{%/link%}}.
* You can also create a project from the Catalyst CLI by executing {{%badge%}}catalyst init{{%/badge%}}. However, you cannot create your first ever Catalyst project from the CLI. You can only do that from the console. Refer to the {{%link href=&#34;/en/cli/v1/cli-command-reference/&#34; %}}CLI documentation{{%/link%}} for more information.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can create upto 50 projects in your account. You can reach out to Catalyst to request an increase to this limit {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}. We will address each request on a case-by-case basis.{{%/note%}}

&lt;br&gt;

### Create a Catalyst Project

Next, let&#39;s create a Catalyst project from the index page in the console:

1. Click {{%bold%}}Create New Project{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;
2. Enter the project&#39;s name in the pop-up window.&lt;br /&gt; &lt;br /&gt;
{{%note%}}{{%bold%}}Note:{{%/bold%}} The project name can only contain alphanumeric characters, underscores and hyphens. Do not include white spaces or other special characters in it.{{%/note%}}
3. Click {{%bold%}}Create{{%/bold%}}.

After your project is created, click {{%bold%}}Access Project{{%/bold%}} to open it.

&lt;br /&gt;

This will redirect you to your project&#39;s page where you can now access Catalyst services, components, settings, and other developer tools for your project.


--------------------------------------------------------------------------------
title: "Navigating in the Console"
description: "The Catalyst remote console enables you to configure the components and project settings, build solutions, add data and code, perform testing, view reports and analytics, and deploy your projects in a highly-integrated, fast environment."
last_updated: "2026-03-18T07:41:08.555Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/navigating-in-the-console/"
service: "All Services"
--------------------------------------------------------------------------------

 
# Navigating in the Console

### Services and Components

After you {{%link href=&#34;/en/getting-started/catalyst-projects/&#34; %}}create your project{{%/link%}} and open it, you will be redirected to the project&#39;s index. You can access all the {{%link href=&#34;/en/&#34;%}}services{{%/link%}} inside the project by navigating to them from the left menu. You can access {{%link href=&#34;/en/codelib/introduction/&#34;%}}CodeLib{{%/link%}} at the bottom of the left pane.

&lt;br /&gt;

You can click **Start Exploring** to access the components in each service.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You will not be able to {{%link href=&#34;/en/deployment-and-billing/environments/initial-deployment/&#34;%}}deploy a service to production{{%/link%}} in the project until you explore it in the console with this button.{{%/note%}}


The components in each service will be grouped into various categories based on their functionalities, features, and purpose.

&lt;br /&gt;

You can access a dashboard from the {{%link href=&#34;/en/serverless/&#34;%}}Serverless{{%/link%}} and {{%link href=&#34;/en/cloud-scale/&#34;%}}Cloud Scale{{%/link%}} services by clicking on the service name at the top. 

&lt;br /&gt;

You can also navigate to other projects by from the drop-down at the top and clicking on a project.


You can return to your account&#39;s index page by clicking on the Catalyst logo at the top.

&lt;br&gt;

### Dashboard

The Serverless and Cloud Scale dashboards contain certain metrics for the day of your project, and directions to {{%link href=&#34;/en/getting-started/installing-catalyst-cli/&#34;%}}install the Catalyst CLI{{%/link%}}, as well as links to various Catalyst help resources.

&lt;br /&gt;

The _Today&#39;s Metrics_ section displays these usage information about your project:

* {{%bold%}}Sync Functions Executions:{{%/bold%}} Number of synchronous {{%link href=&#34;/en/serverless/help/functions/introduction/&#34; %}}functions{{%/link%}} that have been executed on the current day.
* {{%bold%}}Async Functions Executions:{{%/bold%}} Number of asynchronous functions that have been executed on the current day.
* {{%bold%}}Total Component Calls:{{%/bold%}} Total number of component calls made from functions on the current day.
* {{%bold%}}Cron Executions:{{%/bold%}} Number of {{%link href=&#34;/en/cloud-scale/help/cron/introduction/&#34; %}}cron jobs{{%/link%}} executed on the current day.

&lt;br&gt;

### Header

Catalyst provides a {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34; %}}development sandbox and a production environment{{%/link%}} for your project. You can deploy your project to the production environment by clicking **Deploy to Production** from the header after you {{%link href=&#34;/en/deployment-and-billing/billing/setting-up-payment/&#34;%}}set up your payment method{{%/link%}}. 

&lt;br /&gt;

Once deployed, you can use the environment drop-down on the top to switch between the development and production environments in Catalyst and work in them. 

&lt;br /&gt;
 
You can also find notifications common to all your projects by clicking the **notifications** icon. You will receive notifications about various events or processes occurring in each service, after their completion or during their execution. Some examples include: {{%link href=&#34;/en/devops/help/github-integration/implementation/#deploying-a-github-repository-from-catalyst&#34; %}}Deploying a GitHub repository{{%/link%}}, {{%link href=&#34;/en/cloud-scale/help/data-store/columns/#column-characteristics&#34; %}}enabling the search index{{%/link%}} for a column in a table in the Data Store, deploying your project resources from one environment to the other, or training an {{%link href=&#34;/en/zia-services/help/automl/introduction/&#34; %}}AutoML model{{%/link%}}. 

&lt;br /&gt;

You can customize your Catalyst project features, account preferences, or certain component specifications from the settings. We will discuss the **settings** in the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/introduction/&#34; %}}Setting up a Catalyst Project section{{%/link%}}. 

You can access your Zoho user information by clicking on the display picture in your account. You can also find your unique Catalyst {{%link href=&#34;/en/cloud-scale/help/authentication/user-management/users/introduction/&#34; %}}user ID{{%/link%}} here.

&lt;br /&gt;

When you click **My Account** you will be redirected to your {{%link href=&#34;https://accounts.zoho.com/home&#34; %}}Zoho accounts page{{%/link%}} from where you can customize your Zoho account information. 

Catalyst enables you to create and be a part of {{%link href=&#34;/en/getting-started/catalyst-organizations/&#34; %}}multiple organizations{{%/link%}} from the same account, and maintain different sets of projects in each. You can access your multi-org portal from the **Organizations** drop-down in this section. 

This menu also contains links to download various SDKs that you can use in your application. You can also download these SDKs for your project from the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/developer-tools/&#34; %}}Developer Tools settings{{%/link%}}. 

--------------------------------------------------------------------------------
title: "Catalyst Organizations"
description: "Create and manage multiple organizations with a single Catalyst account and maintain different sets of projects in each."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/catalyst-organizations/"
service: "All Services"
--------------------------------------------------------------------------------


# Catalyst Organizations

### Introduction

Catalyst enables you to create and be a part of multiple organizations in your account using the same email address. When you create a new organization in your account, you will be the owner of that org by default. You can create and maintain different sets of {{%link href=&#34;/en/getting-started/catalyst-projects/#introduction-to-catalyst-projects&#34; %}}projects{{%/link%}}  in each organization that you create.

For example consider a freelance developer who works for multiple clients belonging to different organizations with a different set of customer base, revenue sources, and organizational hierarchy in each of them. In such cases, to manage multiple organizations would be a tedious task, requiring you to log in each time into two different accounts. Catalyst enables you to switch between your organizations with the same Catalyst account and also add {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators&#34; %}}collaborators{{%/link%}} from different organizations contributing to a single project within a particular organization.

#### Points to remember:

* If you create an organization of your own, you will be its owner. You can add collaborators for the projects you create in it, either as admins or project members, and grant permissions for the entire org or for specific projects in it. You can perform these actions for each organization that you create individually. 

* If you are added to an organization by another org owner or admin, you will be a collaborator in that org, based on the collaborator type (admin or project member) you are added as. The permissions for you to create projects or perform other actions will be based on your collaborator type. 

* An organization will be referred to by a unique ID automatically generated for it called the {{%bold%}}Org ID{{%/bold%}}. The org ID will be a part of the console URL used to access that org. 

&lt;br&gt;

### Access the Multi-Org Portal

You can access the multi-org work portal in your Catalyst console and manage your organizations by clicking the profile icon on the top left corner. 


The organizations drop-down will display the list of organizations you are a part of. Catalyst allows you to easily switch between organizations directly from this drop-down menu. Click &lt;strong&gt;Manage Organizations&lt;/strong&gt; to access the multi-org portal.


This will open a portal that display the details of all the organizations you have access to, which include the ones you create and the ones you were added to. You can search for an organization by its name using the search bar. 

The portal displays details of an organization, such as its unique org ID and its console URL for easy access. 

The URL is in the format of: `https://console.catalyst.zoho.com/baas/{{OrgID}}/index`


&lt;br&gt;

### Create a New Organization

1. You can create a new organization by clicking &lt;strong&gt;Create Organization&lt;/strong&gt;.

&lt;br /&gt;

2. Provide a name for your organization. You can also enable this organization to be the [default](#the-default-organization), if required.


3. Click &lt;strong&gt;Create Organization&lt;/strong&gt;.

The organization will be created and displayed in the portal with its corresponding details. You can now create projects, add collaborators, and perform other actions in this org.

&lt;br&gt;

### The Default Organization

One of the organizations that you are a part of will be the default organization. When you sign up for a Catalyst account for the first time, Catalyst will create an organization and assign you to it, which will be the default. If you create more organizations in your account, you can enable a different org to be the default.

When you make an organization the default, the following actions are observed :

* Every time you log in to your Catalyst account through the console, {{%link href=&#34;/en/cli/v1/login/login-from-cli/&#34; %}}CLI{{%/link%}}, or through other sources, you will be logged in to the default organization. 

* Every time you execute a Catalyst API, it will be executed for a project or a resource in the default organization, unless you explicitly pass the Org ID of another organization to execute it for. You can refer {{%link href=&#34;/en/api/introduction/multi-org-support/#Multi-OrgSupport&#34; %}}here{{%/link%}} for details. 

* You will not be able to delete an organization that you set as the default.

&lt;br&gt;

### Set an Organization as the Default

You can set an organization as the default in the following way:

1. Click the ellipsis icon for the org to be set as the default from the multi-org portal, then click **Set as Default**.


2. Click **Yes, Proceed** in the confirmation pop-up.


&lt;br&gt;


### Delete an Organization

You can only delete the organization from Catalyst if you are its owner. You will not be able to delete an org that you were added to by another org owner.

{{%note%}}{{%bold%}}Note:{{%/bold%}}  &lt;br&gt;

* If you delete an org, the organization and all the projects created in it will be deleted permanently. The deleted resources cannot be retrieved again. You must therefore ensure that you only delete an org if it is not required permanently. 

* If you need to delete an org that is currently the default, you will need to set another organization as the default before deleting this.

{{%/note%}}

1. Click the ellipsis icon for the org to be set as the default from the multi-org portal, then click **Remove Org**.


2. Click **Yes, Proceed** in the confirmation pop-up.


--------------------------------------------------------------------------------
title: "Introduction to Catalyst SDK"
description: "Catalyst SDK packages provide a host of tools and functionalities that enable you to build functionally-rich, reliable, robust, and secure applications, by incorporating various Catalyst components in them."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/catalyst-sdk/"
service: "All Services"
--------------------------------------------------------------------------------


# Introduction to Catalyst SDK

Software Development Kit (SDK) is a set of tools and libraries that allow developers to create software applications on a specific platform that the SDK targets. The contents of an SDK package include everything that is necessary for
developers to successfully build software applications for that platform.

Catalyst SDK packages provide a host of tools and functionalities that enable you to build functionally-rich, reliable, robust, and secure applications, by incorporating various Catalyst services such as Cloud Scale, Serverless, Zia Services and their components such as Data Store, Functions, Authentication, and more in them. You can easily handle backend jobs in your application by implementing the ready-made functionalities for each service provided by the SDK package, and building on them as per your requirements. This saves you from investing time and effort into coding the backend from scratch, and helps you focus more on designing the user experience of the app.

Catalyst provides SDK packages for the following languages and development environments:

* {{%link href=&#34;/en/sdk/java/v1/overview/&#34; %}}**Java SDK**{{%/link%}}
* {{%link href=&#34;/en/sdk/nodejs/v2/overview/&#34; %}}**Node.js SDK**{{%/link%}}
* {{%link href=&#34;/en/sdk/python/v1/overview/&#34; %}}**Python SDK**{{%/link%}}
* {{%link href=&#34;/en/sdk/web/v4/overview/&#34; %}}**Web SDK**{{%/link%}}
* {{%link href=&#34;/en/sdk/android/v2/overview/&#34; %}}**Android SDK**{{%/link%}}
* {{%link href=&#34;/en/sdk/ios/v2/overview/&#34; %}}**iOS SDK**{{%/link%}}
* {{%link href=&#34;/en/sdk/flutter/v2/overview/&#34; %}}**Flutter SDK**{{%/link%}}

You can access the resources provided to easily understand the process of developing interactive web and mobile applications using Catalyst. The SDK documentation guides provide detailed help on setting up the environments for the specific platform, prerequisites, setup procedures, code syntaxes, and well-explained code samples for integrating each Catalyst service and component in your application’s code.

You can also access the {{%link href=&#34;/en/api/introduction/overview-and-prerequisites/#OverviewandPrerequisites&#34; %}}**Catalyst API Documentation**{{%/link%}} for detailed help on the API available for various services, components and functionalities.

## Setting up a Catalyst Project


--------------------------------------------------------------------------------
title: "Introduction"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/introduction/"
service: "All Services"
--------------------------------------------------------------------------------


# Catalyst Settings

### Introduction

Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project
and your console.

After you {{%link href=&#34;/en/getting-started/catalyst-projects/&#34; %}}create your Catalyst
project{{%/link%}}, you can configure the settings for it and access project-specific details any time. You can also
easily access the required SDK packages for your application from the settings, manage billing, or perform migrations.

To access settings, click on the {{%bold%}}settings icon{{%/bold%}} on the top-right corner of your Catalyst console.


&lt;br&gt;

### Settings Sections

Catalyst settings are displayed under three sections.

&lt;br /&gt;
1. {{%bold%}}General Settings:{{%/bold%}} General settings enable you to set up features that are common to all projects of your Catalyst account. You can access General settings from the {{%link href=&#34;/en/getting-started/catalyst-projects/&#34; %}}index page{{%/link%}} as well.
2. {{%bold%}}Project Settings:{{%/bold%}} Project settings enable you to set up features that are specific to the current project. These can be accessed only within the project.
3. {{%bold%}}Billing:{{%/bold%}} Billing settings enable you to manage your billing and payments for your Catalyst account. You can access Billing settings from the index page as well.

We will discuss each group of Catalyst settings in this help section.

--------------------------------------------------------------------------------
title: "Collaborators"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.556Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/collaborators/"
service: "All Services"
--------------------------------------------------------------------------------

# Collaborators

### Introduction

A collaborator is a co-developer who works with you on building a Catalyst application. You can add collaborators in your organization for the projects in it, and they will be able to access a specific project or all projects in the organization from the Catalyst console or the Catalyst CLI, based on the nature of their collaboration. 

Catalyst enables you to be a part of multiple {{%link href=&#34;/en/getting-started/catalyst-organizations&#34; %}}organizations{{%/link%}} and create different sets of projects in each of them. You can therefore add different collaborators for each organization you create. You can also add collaborators in the orgs you did not create, with {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions&#34; %}}necessary permissions{{%/link%}}.

There are two types of collaborators:

* {{%bold%}}Project Member{{%/bold%}}&lt;br /&gt; A project member has access to the specific project that they have been added to. The access permissions to the project are based on the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions&#34; %}}profiles{{%/link%}} that they have been assigned to.

{{%note%}}{{%bold%}}Note:{{%/bold%}} A project member can be added by another project member with the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions#permissions&#34; %}}necessary permission{{%/link%}}, or an admin of the Catalyst account.{{%/note%}}

* {{%bold%}}Admin of an account{{%/bold%}}&lt;br /&gt; An admin of a Catalyst account has access to all the projects created in the specific organizations they belong to in an account. The admin will have all the permissions of a {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions#default-profiles&#34; %}}Project Owner profile{{%/link%}} enabled for all the projects in the account, and some additional exclusive privileges.
 The exclusive privileges and permissions of a Catalyst account admin are specified in the following table:
 
&lt;table class=&#34;content-table&#34;&gt;
&lt;thead&gt;
&lt;tr&gt;
&lt;th class=&#34;w30p&#34;&gt;Category&lt;/th&gt;
&lt;th class=&#34;w70p&#34;&gt;Permissions&lt;/th&gt;
&lt;/tr&gt;
&lt;/thead&gt;
&lt;tbody&gt;
&lt;tr&gt;
&lt;td&gt;Projects&lt;/td&gt;
&lt;td&gt;Create Projects Update Projects Delete Projects&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;Profiles&lt;/td&gt;
&lt;td&gt;Create Profiles Update Profiles Delete Profiles and Permissions&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;Collaborators&lt;/td&gt;
&lt;td&gt;Delete Collaborators Permanently&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;Git&lt;/td&gt;
&lt;td&gt;Manage Git Integration&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;Billing&lt;/td&gt;
&lt;td&gt;Manage Billing&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;


{{%note%}}{{%bold%}}Note:{{%/bold%}} These are only the additional privileges of a Catalyst account admin. The permissions available for a {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions#default-profiles&#34; %}}Project Owner{{%/link%}}, which are also available to the admin, are not included in this table. {{%/note%}}

#### Super Admin

Catalyst also recognizes a special administrator called the Super Admin. By default, the super admin is the individual who signed up for the Catalyst account. There can only be one super admin for an account.

A super admin has all the privileges and permissions of a Catalyst account admin, and the additional exclusive permission to permanently delete the {{%link href=&#34;#delete-a-catalyst-account-permanently&#34; %}}Catalyst account permanently{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

The Super Admin of a Catalyst account can {{%link href=&#34;/en/getting-started/catalyst-organizations/#create-a-new-organization&#34; %}}create new organizations{{%/link%}} within their account. The person who creates an organization will be the owner of that particular organization by default. However, an org owner need not necessarily be the Super Admin of that Catalyst account. The Super Admin of a Catalyst account and the owner of an organization are different roles. 

{{%/note%}}


In short, the hierarchy of the collaborator types can be depicted as follows:


#### Points to remember:

* Any individual can be directly invited to become a project member by an admin of that account, or another project member with the necessary {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions#permissions&#34; %}}permission{{%/link%}}.
* A project member can be changed to an admin only by another admin. Similarly, an admin can be changed to a project member by another admin.
* A project member cannot be directly changed to a super admin. They must first be made an admin, then be changed to super admin.
* If you are the current super admin of an account, you can change the super admin from yourself to another admin. This will change your account to an admin, and you will no longer have the permission to delete the Catalyst account and its associated orgs permanently. Once the transfer is complete, only the new super admin will have the permission to delete the account and the orgs, and  also change the super admin again.
* A super admin cannot be directly invited by anyone. They must first become an admin of the account, and then be changed by the current super admin.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* A collaborator&#39;s access to Catalyst projects also applies if they use {{%link href=&#34;/en/cli/v1/cli-command-reference/&#34; %}}Catalyst CLI{{%/link%}}. A project member can only use projects, pull resources from projects, or deploy to projects that they have been assigned to using the CLI. An admin can access all the projects created in that Catalyst account from the CLI as well.

* Catalyst allows upto 100 collaborators in an account. You can request Catalyst for an increase in this limit by contacting our support at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}support@zohocatalyst.com{{%/link%}}. We will address each request on a case-by-case basis.
{{%/note%}}

### Add a Collaborator

You can invite collaborators or assign new projects to existing members of other projects in an organization as follows:

1. Navigate to {{%bold%}}Settings{{%/bold%}} in your Catalyst console.&lt;br /&gt; &lt;br /&gt; The _Collaborators_ section will open under the General Settings.
2. Click {{%bold%}}Add or Assign{{%/bold%}} from the _Collaborators_ section.&lt;br /&gt; &lt;br /&gt;
3. Select whether you want to add a project member or an admin for the whole account. If you select {{%bold%}}Project Member{{%/bold%}}, you must choose the project from the dropdown list below.
&lt;br /&gt; &lt;br /&gt;
{{%note%}}{{%bold%}}Note:{{%/bold%}} You can also {{%link href=&#34;#assign-a-new-project-to-a-project-member&#34; %}}assign{{%/link%}} other projects to a project member from their details section, after they have been invited for the first time. {{%/note%}}

4. Enter the email addresses of the people you wish to invite.
&lt;br /&gt; &lt;br /&gt; The console will list existing members of the organization that you can select to invite. You can also manually add members from other organizations. This is another way of assigning a new project to an existing member of the organization, or adding an existing project member as an admin.

5. If you selected {{%bold%}}Project Member{{%/bold%}}, select a profile to assign each member to for the chosen project. All {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions&#34; %}}default profiles and custom profiles{{%/link%}} will be listed in the dropdown list.&lt;br /&gt; 
You can add more project members or remove added members by clicking the {{%bold%}}\&#43;{{%/bold%}} and {{%bold%}}\-{{%/bold%}} icons.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can only invite 10 members at a time. {{%/note%}}
&lt;br /&gt; The option to select a project or a profile will not appear if you select {{%bold%}}Admin for the Whole Account{{%/bold%}}.


6. Click {{%bold%}}Confirm{{%/bold%}}.

Catalyst will then send them email invites to access the project or the entire organization that they were added into. 

When the collaborator clicks on the link in the email, they will be redirected to a sign-in page to access their Catalyst console.

If the collaborator does not have a Zoho account, they will be redirected to a sign-up page where they must first create an account. The collaborator&#39;s details, such as their first and last name, will be populated automatically from their Zoho account details.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can assign up to a 100 collaborators to a single Catalyst organization within your Catalyst account. The distribution of admins and members of the project is flexible based on your requirements. For example, you can have 1 admin and 99 project members or 50 admins and 50 project members. However, the total number cannot exceed 100. If you specifically require more than a hundred collaborators for a project, write to us at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}support@zohocatalyst.com{{%/link%}} with the details of your request. {{%/note%}}

The collaborators that you invite will be listed in the _Collaborators_ section. You can click on their name to view their details.


Until a collaborator accepts the invitation and joins the project, an &#39;Invitation Pending&#39; banner will be displayed. You can resend the email invite by clicking the {{%bold%}}Reinvite{{%/bold%}} button.

An admin&#39;s details section will list all the projects of that Catalyst organization as their assigned projects by default.


You can search for a collaborator by their name or email using the search bar at top of the section. You can also filter the collaborators listed in the section by selecting one of these categories.


After a collaborator accepts their invite, their status will be moved from _Pending Invites_ to _Active Members_ or _Admins_, based on their collaboration type. The admins will be marked with a yellow star and the Super Admins will be marked with an orange star in their details section.

You can find all the admins of the account, including the Super Admin, in the _Admins_ list, and the project members in the _Active Members_ list. You can select _Deleted Collaborators_ to view the list of {{%link href=&#34;#delete-a-colloborator&#34; %}}collaborators that were deleted{{%/link%}} from an account in the section.

You can also select a project to view just the collaborators for that project. The admins of the account will be listed under each project, as they have access to all the projects.

{{%bold%}}Points to remember:{{%/bold%}}

* The {{%bold%}}Add or Assign{{%/bold%}} and {{%bold%}}Reinvite{{%/bold%}} options will only be available to the members of the project who have the necessary {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions#permissions&#34; %}}permissions{{%/link%}}. These options will be available to all the admins by default.
* A project member will only see a list of project members and admins for the projects that they have access to.
* Any information about other projects or their members that a project member does not have access to will not be shown anywhere in their console.

&lt;br&gt;

### Assign a New Project to a Project Member

You can assign any number of projects in an organization to an existing project member with the necessary permissions in the following way :

1. Navigate to the project member&#39;s details section in _Settings_, then click {{%bold%}}Assign New Project{{%/bold%}}.&lt;br /&gt; 

2. Select a project to assign the project member to and their role in that project from the dropdown lists. Click {{%bold%}}Assign{{%/bold%}}.&lt;br /&gt; 

All projects that a project member is assigned to will be listed in their details section.


&lt;br&gt;

### Remove a Project Member from a Project

You can remove a project member from a specific project in the following way:

1. Click the ellipsis icon for the project that the project member must be removed from, in the list in the collaborator&#39;s details section. Click {{%bold%}}Remove from Project{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;
{{%note%}}{{%bold%}}Note:{{%/bold%}} Only project members with the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions#permissions&#34; %}}Add/Update/Remove Collaborators permission{{%/link%}} or admins can do this.{{%/note%}}

2. Click {{%bold%}}Yes, Proceed{{%/bold%}} in the confirmation pop-up.&lt;br /&gt; 

{{%note%}}{{%bold%}}Note:{{%/bold%}} An admin cannot be removed from a project in the org they belong to. They will have access to all projects created in that org.{{%/note%}}

&lt;br&gt;

### Change a Collaborator&#39;s Type

As mentioned in the introduction section, you can change a project member to an admin, an admin to a super admin or a project member, or change the super admin. The options to make these changes will be available in a collaborator&#39;s details section, depending on their current type.

{{%note%}}{{%bold%}}Note:{{%/bold%}} A collaborator&#39;s type can only be changed by another collaborator on a {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/#introduction&#34; %}}higher level of hierarchy{{%/link%}}.{{%/note%}}

#### Change a Project Member to an Account Admin

You can change a project member to an account admin in the following way:

1. Click on the project member&#39;s details section from the _Collaborators_ list, then click {{%bold%}}Change to Admin{{%/bold%}}.&lt;br /&gt; 

2. Click {{%bold%}}Confirm{{%/bold%}} in the pop-up.&lt;br /&gt; 

This collaborator will now have project owner access to all the projects in that organization and the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/#introduction&#34; %}}additional privileges of a Catalyst account admin{{%/link%}}.

&lt;br /&gt;

#### Change a Catalyst Account Admin to Super Admin

As mentioned earlier, there can be only be one Super Admin for a Catalyst account. Changing the Super Admin from yourself to another admin will change your account to an admin.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Only the current Super Admin can perform this operation.{{%/note%}}

You can change a Catalyst account Admin to a Super Admin in the following way:

1. Click on an admin&#39;s details section from the _Collaborators_ list, then click {{%bold%}}Change to Super Admin{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;
2. Click {{%bold%}}Confirm{{%/bold%}} in the confirmation pop-up.&lt;br /&gt; 

The new super admin will now have the additional permission to delete the Catalyst account permanently. 

&lt;br /&gt;

#### Change a Catalyst Account Admin to a Project Member

Changing an admin to a project member will remove their access to all the projects in the Catalyst organization immediately. They can then be assigned to the required projects individually as explained in {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/#introduction&#34; %}}this section{{%/link%}}.

You can change a Catalyst account admin to a project member in the following way:

1. Open the admin&#39;s details section from the _Collaborators_ list. Click the ellipsis icon, then click {{%bold%}}Change to Project Member{{%/bold%}}.&lt;br /&gt; 

2. Click {{%bold%}}Confirm{{%/bold%}} in the confirmation pop-up.&lt;br /&gt; 

You can now assign the project member individual projects that they need access to.


&lt;br&gt;

### Delete a Collaborator

As specified in the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/#introduction&#34; %}}exclusive permissions of a Catalyst account admin{{%/link%}}, an admin or a super admin can delete a project member or another admin permanently from an organization. 

This will revoke their access to the Catalyst console for that Catalyst organization, and they will be removed from that organization permanently. They will also not be able to access any Catalyst projects of that organization from the CLI.

To add them back to the organization, a project member with the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions#permissions&#34; %}}necessary permission{{%/link%}} or an admin must invite them again from the console as described in {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/#add-a-collaborator&#34; %}}this section{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* You can remove a collaborator from each project individually, if needed, and retain their Catalyst organization, instead of deleting them permanently.

* Even if a collaborator is removed from an organization they were added to, they will still be a part of organizations they have created in their own account and can access the projects in them.

* Deleting a collaborator from all organizations will not delete their Zoho account. Their {{%link href=&#34;https://accounts.zoho.com/home&#34; %}}Zoho Accounts page{{%/link%}} will still show other Zoho services that they use.

* If you delete a collaborator who has not accepted the invitation to access the Catalyst project or organization, the invite link sent to them by email will become invalid.
{{%/note%}}

To delete a collaborator from Catalyst permanently:

1. Open the admin&#39;s details section from the _Collaborators_ list. Click the ellipsis icon, then click {{%bold%}}Delete{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;
2. Type &#34;DELETE&#34; in the confirmation pop-up and click {{%bold%}}Confirm{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;

The deleted collaborator will still be listed in the _Collaborators_ section.

&lt;br /&gt;

You can select the {{%bold%}}Deleted Collaborators{{%/bold%}} filter under the search bar in this section to view a list of deleted collaborators in the account.

### Delete a Catalyst Account Permanently

As mentioned before, the Super Admin of a Catalyst account can delete the account permanently. This will delete all projects and resources created from the account.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* Before you delete a Catalyst account, you must delete all the collaborators in the account individually. This includes members of all the projects and admins of that account. You can then proceed to delete the account.

* If you delete a Catalyst account permanently, all applications and microservices hosted from that Catalyst account will be deleted and become inaccessible to the end users. You must therefore proceed with caution before deleting an account.
{{%/note%}}

To delete a Catalyst account permanently:

1. Click on the ellipsis icon on the bottom of the _Collaborators_ section in _Settings_, then click {{%bold%}}Delete Catalyst Account{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;
2. Type &#34;DELETE&#34; in the confirmation pop-up and click {{%bold%}}Confirm{{%/bold%}}. &lt;br /&gt; 

 &lt;br /&gt;

The account will be permanently deleted.

{{%note%}}{{%bold%}}Note:{{%/bold%}} If you have pending bill payments in your Catalyst account, you must clear all dues before you delete the account. The account will not be deleted until all pending bill payments are made.{{%/note%}}

--------------------------------------------------------------------------------
title: "Profiles and Permissions"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.558Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions/"
service: "All Services"
--------------------------------------------------------------------------------


# Profiles and Permissions

### Introduction

A profile represents a collection of permissions and privileges that gives project members access to various components and features inside a project.

When you add a new project member, you must assign them to a specific profile for each project that they are added to. You can assign them to one of the default profiles, or define custom profiles based on your needs and use them instead.

All profiles and permissions are project specific, and not account specific. You can assign the same individual to different profiles in different projects, and thereby grant different levels of access in each project. This enables you to provide only the relevant authorization to project members based on your organization&#39;s requirements.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* Profiles do not apply to Catalyst account admins or the Super Admin. Only project members can be assigned to profiles for each project.
* Catalyst provides permissions to project members in compliance with all relevant and applicable data protection laws and privacy guidelines, such as {{%link href=&#34;https://gdpr-info.eu/&#34; %}}GDPR{{%/link%}} and {{%link href=&#34;https://www.hhs.gov/hipaa/index.html&#34; %}}HIPAA{{%/link%}} regulations. This helps you readily implement user data protection regulations and build applications in accordance with them.
{{%/note%}}


### Permissions

The permissions defined by Catalyst are grouped into several categories. A Catalyst account admin can grant or deny any individual permission for a custom profile while creating it. Any default or custom profile can be assigned to a project member by an admin or another member with the _Add/Update/Remove Collaborators_ permission.

Before you learn about the permissions defined in Catalyst, you must understand the {{%bold%}}Access Types{{%/bold%}} available for those permissions:

* {{%bold%}}Editor{{%/bold%}}&lt;br /&gt; Editor access enables the project member to modify the configurations and data of the components they have permission to access. Editor access is available for all permissions defined in Catalyst.
* {{%bold%}}Viewer{{%/bold%}}&lt;br /&gt; Viewer access enables the project member to only view the configurations and data of the components they have permission to access.
&lt;br /&gt;&lt;br /&gt; Viewer access is only available for four permissions from the permissions listed below: _Development Environment_, _Production Environment_, _Manage Settings and Configuration_. The details are explained in the table below.

The following permissions are defined and available in Catalyst for the {{%bold%}}Editor Access Type{{%/bold%}}:

&lt;table class=&#34;content-table&#34;&gt;
&lt;thead&gt;
&lt;tr&gt;
&lt;th class=&#34;w20p&#34;&gt;Permissions Group&lt;/th&gt;
&lt;th class=&#34;w30p&#34;&gt;Permissions&lt;/th&gt;
&lt;th class=&#34;w50p&#34;&gt;Description&lt;/th&gt;
&lt;/tr&gt;
&lt;/thead&gt;
&lt;tbody&gt;
&lt;tr&gt;
&lt;td&gt;&lt;strong&gt;Manage Collaborators&lt;/strong&gt;&lt;/td&gt;
&lt;td&gt;Add/Update/Remove Collaborators&lt;/td&gt;
&lt;td&gt;This provides permission to invite a project member or an admin, assign other projects to a project member, change the collaboration type for a lower level of hierarchy, or remove a project member from a project.&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;strong&gt;Development Environment&lt;/strong&gt;&lt;/td&gt;
&lt;td&gt;Data Store &lt;br&gt;File Store &lt;br&gt;Logs &lt;br&gt;Event Listeners &lt;br&gt; Other Components&lt;/td&gt;
&lt;td&gt;If Editor access to the Data Store, File Store, Event Listeners, Logs, or Other Components is granted, the project member can configure the respective components and add data in them in the &lt;a href=&#34;/en/deployment-and-billing/environments/development-environment&#34;&gt;development environment&lt;/a&gt; of that project. development environment of that project. &lt;br&gt; &lt;div class=&#34;note&#34;&gt;&lt;strong&gt;Note:&lt;/strong&gt; Catalyst enables you to provide access to the Data Store, File Store, Event Listeners, and Logs independently, and groups other components such as Circuits, Functions, Cron etc under &#34;Other Components&#34; because, the independent components can contain sensitive user data that you might require exclusive control on. This is done to adhere to all applicable data protection laws and privacy guidelines, such as GDPR and HIPAA.You will not be able to unselect the permission for &#34;Other Components&#34; in the development environment, because that is the minimum level of permission that can be granted to a project member. If you choose to provide permission to access Event Listeners, you must provide permissions to access Data Store and File Store prior to that. This is because, Catalyst shows sample event data patterns in the console with relevant data of the Data Store or File Store when you &lt;a href=&#34;/en/cloud-scale/help/event-listeners/component-event-listeners/&#34;&gt;configure a Component event listener&lt;/a&gt; with those components, and therefore project members must already have access to those components.&lt;/div&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;strong&gt;Production Environment&lt;/strong&gt;&lt;/td&gt;
&lt;td&gt;Data Store File Store Logs Event Listeners Other Components&lt;/td&gt;
&lt;td&gt;If Editor access to the Data Store, File Store, Logs, Event Listeners, or Other Components is granted, the project member can configure the respective components and add data in them in the &lt;a href=&#34;/en/deployment-and-billing/environments/production-environment&#34;&gt;production environment&lt;/a&gt; of that project. &lt;div class=&#34;note&#34;&gt;&lt;strong&gt;Note:&lt;/strong&gt;  Similar to the development environment, Catalyst lists out the first three components independently as they can contain sensitive user data. If you select Data Store, File Store, Event Listeners, or Logs in the production environment, &#34;Other Components&#34; will be selected by default. To unselect it, you will need to unselect any/all of the three independent components. Similar to the development environment, if you choose to provide permission to access Event Listeners, you must provide permission to access Data Store and File Store prior to that.&lt;/div&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;strong&gt;Manage Add-On Services&lt;/strong&gt;&lt;/td&gt;
&lt;td&gt;Enable/Disable Add-On Services&lt;/td&gt;
&lt;td&gt;This provides the permission to enable or disable any of the Catalyst Add-On Services for that project.&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;strong&gt;Manage Settings and Configurations&lt;/strong&gt;&lt;/td&gt;
&lt;td&gt;Perform Migrations&lt;/td&gt;
&lt;td&gt;This provides the permission to migrate the project from development to production or production to development, and perform all migration actions.&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;/td&gt;
&lt;td&gt;Enable/Disable Production Environment&lt;/td&gt;
&lt;td&gt;This provides the permission to &lt;a href=&#34;/en/deployment-and-billing/environments/production-environment&#34;&gt;enable or disable the production environment&lt;/a&gt; any time after the project has been deployed to production.&lt;/td&gt;
&lt;td&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;/td&gt;
&lt;td&gt;Access Billing Components&lt;/td&gt;
&lt;td&gt;If Editor access to this permission is granted, the project member can access the &lt;a href=&#34;/en/deployment-and-billing/billing/introduction&#34;&gt;Billing&lt;/a&gt; settings (except the Overview and Manage Billing sections), create budgets, and view reports and breakdowns of that project. &lt;strong&gt;Viewer:&lt;/strong&gt; If Viewer access to this permission is granted, the project member can only view reports and breakdowns of that project, but cannot create or manage budgets. &lt;div class=&#34;note&#34;&gt;&lt;strong&gt;Note:&lt;/strong&gt;  Only the admins of a Catalyst account can access the &lt;a href=&#34;/en/deployment-and-billing/billing/introduction&#34;&gt;Overview section&lt;/a&gt; under the Billing settings because that section displays information from all projects of that Catalyst account.  Only the admins of a Catalyst account can access the &lt;a href=&#34;/en/deployment-and-billing/billing/manage-billing&#34;&gt;Manage Billing&lt;/a&gt; or Payments Portal section. This means that only admins can set up the payment method, add credit cards, and manage all payment and transaction related activities for the Catalyst account. A project member cannot perform these activities.&lt;/div&gt;&lt;/td&gt;
&lt;td&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;/td&gt;
&lt;td&gt;Add/Delete Mobile Packages&lt;/td&gt;
&lt;td&gt;This provides the permission to add or delete Android or iOS SDK packages for the project from the &lt;a href=&#34;/en/getting-started/set-up-a-catalyst-project/developer-tools&#34;&gt;&lt;em&gt;Developer Tools&lt;/em&gt; settings&lt;/a&gt; in the console.&lt;/td&gt;
&lt;td&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;&lt;/td&gt;
&lt;td&gt;Access Audit Logs&lt;/td&gt;
&lt;td&gt;This provides the permission to view the &lt;a href=&#34;/en/getting-started/set-up-a-catalyst-project/audit-logs&#34;&gt;audit logs&lt;/a&gt; of all the projects in your Catalyst account. &lt;strong&gt;Note:&lt;/strong&gt; If you choose to provide permission to access Audit Logs, you must provide permission to access Data Store, File Store, Event Listeners, and Other Components prior to that. This is because, Catalyst shows the configurations and data of these components in the Audit Logs settings in the console, and therefore project members must already have permissions to those components.&lt;/td&gt;
&lt;td&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;

### Default Profiles

Catalyst has three default profiles, each of which has predefined sets of permissions. You can view the default profiles by clicking the {{%bold%}}Profiles &amp; Permissions{{%/bold%}} section in _General Settings_.


{{%note%}}{{%bold%}}Note:{{%/bold%}} These default profiles cannot be modified or deleted. {{%/note%}}

The default profiles and the permissions included in them are:

* {{%bold%}}Project Owner{{%/bold%}}&lt;br /&gt;&lt;br /&gt; A project member assigned to the Project Owner profile will have Editor access to {{%bold%}}all the permissions{{%/bold%}} for that project, as specified in the table in the previous section. A Project Owner is the highest privilege granted to a project member and makes all permissions and access available to them.

You can click {{%bold%}}Project Owner{{%/bold%}} from the _Profiles and Permissions_ section to view the details.&lt;br /&gt; &lt;br /&gt;
{{%note%}}{{%bold%}}Note:{{%/bold%}} A project owner will still not have the exclusive privileges granted to a Catalyst account admin. This is in the highest level of hierarchy for project member type only.{{%/note%}}

* {{%bold%}}Contributor{{%/bold%}}&lt;br /&gt;&lt;br /&gt; A project member assigned to the Contributor profile will have Editor access to work with all the components and data of the development and production environments. They can also perform migrations, and enable or disable the production environment. However, they will not have any other permissions specified in the table in the previous section.&lt;br /&gt; &lt;br /&gt; You can assign the Contributor profile to members who are involved in developing the application, but do not manage the Catalyst account or project settings.

* {{%bold%}}Viewer{{%/bold%}}&lt;br /&gt;&lt;br /&gt; A project member assigned to the Viewer profile will have Viewer access to the development and production environments. This means that they can view the configurations and data of all the components in the developer and production environment of that project, but will not be able to modify any components or data.&lt;br /&gt; &lt;br /&gt; You can assign the Viewer profile to members from a different department of your organization, or anyone who is not actively involved in developing the application but would like to observe the schema and data.&lt;br /&gt;
{{%note%}}{{%bold%}}Note:{{%/bold%}} The Viewer profile is not the same as the Viewer access type. You can grant the Viewer access type to any custom profile and include only some of those permissions available for it.{{%/note%}}

### Create a New Custom Profile

A Catalyst account admin or the Super Admin can create custom profiles and define the permissions to be included in them. A project member will not be able to create or manage custom profiles.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst allows you to create upto 50 custom profiles in an account in the {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34; %}}development environment{{%/link%}}. You can request Catalyst for an increase in this limit by contacting our support at {{%link href=&#34;mailto:support@zohocatalyst.com&#34; %}}{{%bold%}}support@zohocatalyst.com{{%/bold%}}{{%/link%}}. We will address each request on a case-by-case basis. There are no upper limits for profile creation in the production environment.{{%/note%}}

To create a new custom profile for a Catalyst account:

1. Click {{%bold%}}Profiles &amp; Permissions{{%/bold%}} under _General Settings_, then click {{%bold%}}Add New Profile{{%/bold%}} from that section.&lt;br /&gt; 
2. Provide a name and a description for the custom profile. Select the {{%bold%}}Access Type{{%/bold%}} of the profile.&lt;br /&gt; 
3. Select the required permissions that must be included in the profile. You can click the {{%bold%}}Select All{{%/bold%}} checkbox in the top-right corner to select all the permissions.&lt;br /&gt; 
{{%note%}}{{%bold%}}Note:{{%/bold%}} The Other Components permission in Development Environments permission is available to both Editor and Viewer access types for any profile that you create by default. This is the minimum level of permission that you can include in a profile and grant to a project member. You will not be able to unselect this or remove this permission.{{%/note%}}

4. Click {{%bold%}}Confirm{{%/bold%}}.

The profile will be created and listed in the _Profiles and Permissions_ section. You can click on it to view the details.


A Catalyst account admin or a project member with the _Add/Update/Remove Collaborators_ permission can assign a profile to another project member while inviting them, as {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/#add-a-collaborator&#34; %}}discussed previously{{%/link%}}.


### Change a Project Member&#39;s Profile

You can also change the profile assigned to a project member for a project, with the necessary permission, in the following way:

1. Navigate to the {{%bold%}}Collaborators{{%/bold%}} section in {{%bold%}}General Settings{{%/bold%}} and click the project member from the list to open their details. Click the ellipsis icon for the project that their profile must be changed in, then click {{%bold%}}Change Profile{{%/bold%}}.&lt;br /&gt; 

2. Select a profile from the dropdown list. Then select the check icon.&lt;br /&gt; 

The project member&#39;s permissions to access that project will now be changed based on the profile you selected.


### Edit a Custom Profile

To edit a custom profile or modify the permissions included in it:

1. Click the ellipsis icon for the profile in the _Profiles and Permissions_ section, then click {{%bold%}}Edit{{%/bold%}}. Alternatively, you can click {{%bold%}}Edit{{%/bold%}} from the profile&#39;s details page.&lt;br /&gt; &lt;br /&gt;
2. Make the necessary changes to the profile. Click {{%bold%}}Update{{%/bold%}}.&lt;br /&gt; 

### Delete a Custom Profile

When you delete a custom profile, you must replace it with another profile. This will migrate all the project members assigned to that profile to the replacement profile. Their permissions to access the projects will be changed accordingly.

To delete a custom profile:

1. Click the ellipsis icon for the profile in the _Profiles and Permissions_ section, then click {{%bold%}}Delete{{%/bold%}}.
&lt;br /&gt; 

2. Select the profile to replace this with, from the dropdown list. Click {{%bold%}}Yes, Delete{{%/bold%}}.&lt;br /&gt; 

--------------------------------------------------------------------------------
title: "IaC Settings"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.559Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/iac-settings/"
service: "All Services"
--------------------------------------------------------------------------------


# IaC Settings

### Introduction

The Infrastructure as Code (IaC) settings enable you to perform project exports and imports easily from the Catalyst console. You can export the schema of a {{%link href=&#34;/en/getting-started/catalyst-projects&#34; %}}Catalyst project{{%/link%}}, including the configurations of its components and the code, as an external ZIP file. You can import this ZIP file as a new project into any Catalyst account. The ZIP file is created in a specific format when you export a project, and it can only be imported in this format.

The project export and import feature enables easy transfers of projects between data centers or between Catalyst accounts. It also enables easy access and testing of a project from an external environment, such as a GitHub repository. You can simply clone a Git repo containing a Catalyst project&#39;s components, generate its ZIP file to import it, and test the project. You can also perform these actions through a remote system, such as a CI system, or write scripts to automate these tasks. This feature also allows you to easily duplicate existing projects and branch them for different use cases.

You can access the IaC project exports and imports feature under the _{{%bold%}}General settings{{%/bold%}}_ in the Catalyst console.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can also perform these IaC operations from the CLI. The CLI enables you to export a project into your local directory, import a new project in the remote console and/or the local environment, or generate an import-ready ZIP file of any project. Refer to {{%link href=&#34;/en/cli/v1/export-and-import-projects/introduction/&#34; %}}CLI Export and Import help documentation{{%/link%}} for more information.{{%/note%}}


### Export/Import ZIP File Format

The IaC operations enable you to export and import the configurations of a project without the data. Data, such as the records in the Data Store tables, the list of the application&#39;s users, or files from the File Store, will not be included in the ZIP file. However, the metadata of each table in the Data Store or the folder structures of the File Store will be included. This will be the same for every feature.

The ZIP file will also contain all the {{%link href=&#34;/en/serverless/help/functions/introduction/&#34; %}}functions{{%/link%}} and the client component code in their {{%link href=&#34;/en/cli/v1/project-directory-structure/introduction/&#34; %}}respective directories{{%/link%}}.

The structure of the ZIP file that is generated when a project is exported is shown below:


* {{%bold%}}ZIP File of the Functions Directory:{{%/bold%}} The {{%badge%}}{{%link href=&#34;/en/cli/v1/project-directory-structure/functions-directory/&#34; %}}functions directory{{%/link%}}{{%/badge%}} of the project in its standard structure. All functions created in the project will be present as individual ZIP files in this directory, along with their configuration files and SDK components.
* {{%bold%}}ZIP File of the Client Directory:{{%/bold%}} The {{%badge%}}{{%link href=&#34;/en/cli/v1/project-directory-structure/client-directory/&#34; %}}webclient directory{{%/link%}}{{%/badge%}} of the project in its standard structure. The web client initialized in the project, with all the client files, will be present as a ZIP file in this folder.
* {{%bold%}}Project-Template JSON File:{{%/bold%}} The configurations of the project&#39;s components will be present in a single JSON file. The JSON file contains the project settings and component definitions. These include Data Store and File Store metadata, Cache segments, Cron jobs, Circuit configurations, Security rules, email domains and addresses, Event Listeners and rules, APIs in API Gateway, email templates, user profiles, and more.

An extract from a sample project-template JSON is given below:

{{%code class=&#34;language-json line-numbers&#34;%}}{
  &#34;name&#34; : &#34;project-template&#34;,
  &#34;version&#34; : &#34;1.0.0&#34;,
  &#34;parameters&#34; : { },
  &#34;components&#34; : {
    &#34;Circuits&#34; : [ {
      &#34;type&#34; : &#34;circuit&#34;,
      &#34;name&#34; : &#34;InvoiceGen&#34;,
      &#34;properties&#34; : {
        &#34;name&#34; : &#34;InvoiceGen&#34;,
        &#34;states&#34; : {
          &#34;State1&#34; : {
            &#34;next&#34; : &#34;End&#34;,
            &#34;start&#34; : true,
            &#34;type&#34; : &#34;pass&#34;
          }
        }
      },
      &#34;dependsOn&#34; : [ ]
    } ],
    &#34;Functions&#34; : [ {
      &#34;type&#34; : &#34;function&#34;,
      &#34;name&#34; : &#34;warehouseportal&#34;,
      &#34;properties&#34; : {
        &#34;stack&#34; : &#34;node14&#34;,
        &#34;code&#34; : {
          &#34;path&#34; : &#34;functions/warehouseportal.zip&#34;
        },
        &#34;configuration&#34; : {
          &#34;memory&#34; : 256
        },
        &#34;type&#34; : &#34;basicio&#34;,
        &#34;name&#34; : &#34;warehouseportal&#34;
      },
      &#34;dependsOn&#34; : [ ]
    }
 ],
    &#34;WebClient&#34; : [ {
      &#34;type&#34; : &#34;client&#34;,
      &#34;name&#34; : &#34;warehousePortal&#34;,
      &#34;properties&#34; : {
        &#34;app_name&#34; : &#34;warehousePortal&#34;,
        &#34;code&#34; : {
          &#34;path&#34; : &#34;webclient/warehousePortal.zip&#34;
        }
      },
      &#34;dependsOn&#34; : [ ]
    } ],
    &#34;Cron&#34; : [ {
      &#34;type&#34; : &#34;cron&#34;,
      &#34;name&#34; : &#34;dailyBackup&#34;,
      &#34;properties&#34; : {
        &#34;cron_url_details&#34; : {
          &#34;headers&#34; : { },
          &#34;request_body&#34; : &#34;&#34;,
          &#34;request_method&#34; : &#34;POST&#34;,
          &#34;params&#34; : { },
          &#34;url&#34; : &#34;https://catalyst.zoho.com/help/index.html&#34;
        },
        &#34;end_time&#34; : -1,
        &#34;description&#34; : &#34;&#34;,
        &#34;cron_name&#34; : &#34;dailyBackup&#34;,
        &#34;job_detail&#34; : {
          &#34;hour&#34; : 1,
          &#34;timezone&#34; : &#34;America/Los_Angeles&#34;,
          &#34;minute&#34; : 0,
          &#34;second&#34; : 0,
          &#34;repetition_type&#34; : &#34;Daily&#34;
        },
        &#34;cron_type&#34; : &#34;Calendar&#34;,
        &#34;status&#34; : true
      },
      &#34;dependsOn&#34; : [ ]
    } ],
    &#34;Datastore&#34; : [ {
      &#34;type&#34; : &#34;table&#34;,
      &#34;name&#34; : &#34;InventoryDB&#34;,
      &#34;properties&#34; : {
        &#34;table_name&#34; : &#34;InventoryDB&#34;
      },
      &#34;dependsOn&#34; : [ ]
    }, {
      &#34;type&#34; : &#34;column&#34;,
      &#34;name&#34; : &#34;InventoryDB-ProductID&#34;,
      &#34;properties&#34; : {
        &#34;decimal_digits&#34; : 2,
        &#34;column_name&#34; : &#34;ProductID&#34;,
        &#34;data_type&#34; : &#34;int&#34;,
        &#34;is_unique&#34; : false,
        &#34;is_mandatory&#34; : false,
        &#34;search_index_enabled&#34; : false,
        &#34;table_id&#34; : &#34;InventoryDB&#34;,
        &#34;table_name&#34; : &#34;InventoryDB&#34;,
        &#34;max_length&#34; : 10
      },
      &#34;dependsOn&#34; : [ &#34;Datastore.table.InventoryDB&#34; ]
    },
{
      &#34;type&#34; : &#34;tableScope&#34;,
      &#34;name&#34; : &#34;InventoryDB-App Administrator&#34;,
      &#34;properties&#34; : {
        &#34;role_name&#34; : &#34;App Administrator&#34;,
        &#34;table_scope&#34; : &#34;GLOBAL&#34;,
        &#34;type&#34; : &#34;App Administrator&#34;,
        &#34;table_name&#34; : &#34;InventoryDB&#34;
      },
      &#34;dependsOn&#34; : [ &#34;Datastore.table.InventoryDB&#34; ]
    }, {
      &#34;type&#34; : &#34;tableScope&#34;,
      &#34;name&#34; : &#34;InventoryDB-App User&#34;,
      &#34;properties&#34; : {
        &#34;role_name&#34; : &#34;App User&#34;,
        &#34;table_scope&#34; : &#34;GLOBAL&#34;,
        &#34;type&#34; : &#34;App User&#34;,
        &#34;table_name&#34; : &#34;InventoryDB&#34;
      },
      &#34;dependsOn&#34; : [ &#34;Datastore.table.InventoryDB&#34; ]
    }, {
      &#34;type&#34; : &#34;tablePermission&#34;,
      &#34;name&#34; : &#34;InventoryDB-App Administrator&#34;,
      &#34;properties&#34; : {
        &#34;role_name&#34; : &#34;App Administrator&#34;,
        &#34;type&#34; : &#34;App Administrator&#34;,
        &#34;table_permissions&#34; : [ &#34;SELECT&#34;, &#34;UPDATE&#34;, &#34;INSERT&#34;, &#34;DELETE&#34; ],
        &#34;table_name&#34; : &#34;InventoryDB&#34;
      },
      &#34;dependsOn&#34; : [ &#34;Datastore.table.InventoryDB&#34; ]
    }, {
      &#34;type&#34; : &#34;tablePermission&#34;,
      &#34;name&#34; : &#34;InventoryDB-App User&#34;,
      &#34;properties&#34; : {
        &#34;role_name&#34; : &#34;App User&#34;,
        &#34;type&#34; : &#34;App User&#34;,
        &#34;table_permissions&#34; : [ &#34;SELECT&#34; ],
        &#34;table_name&#34; : &#34;InventoryDB&#34;
      },
      &#34;dependsOn&#34; : [ &#34;Datastore.table.InventoryDB&#34; ]
    }]
}
}{{%/code%}}


{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst will not be able to import a project if the ZIP file does not contain the project-template JSON file. This is a mandatory file that defines the project&#39;s settings.{{%/note%}}

### Export a Project

You can export any project from the _General Settings_ section, as these are common settings applicable to your entire Catalyst account.

Catalyst will write all the component definitions and the project settings into the project-template JSON file. If no components have been configured, the default configurations will be written to the JSON file.

{{%note%}}{{%bold%}}Note:{{%/bold%}} If you worked with a project in the local environment, ensure that you deploy the updated code or setups to the remote console using the CLI before you export the project from the console.{{%/note%}}

You can export a project from its {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34;%}}development or production environment{{%/link%}}, if production has been enabled for it. After the export is complete, you can download the ZIP file that will be generated. You can then import this ZIP file as is into a new project from a different account, data center, or the same account if you need the project to be duplicated.

{{%note%}}{{%bold%}}Note:{{%/bold%}} After the ZIP file is generated, Catalyst will save the file for download for {{%bold%}}15 days{{%/bold%}}. The download link will become invalid after 15 days. You will need to re-export the project to generate a new ZIP file for download after its expiration.{{%/note%}}

To export a project:

1. Navigate to {{%bold%}}Infrastructure as Code{{%/bold%}} under _General Settings_, then click the {{%bold%}}IaC Exports{{%/bold%}} tab.&lt;br /&gt; &lt;br /&gt;
2. Click {{%bold%}}Export a Project{{%/bold%}}.
3. Select a project to export from the list of projects in the drop-down. All projects in your Catalyst account will be shown here. Select the environment of the project to export.&lt;br /&gt; &lt;br /&gt;
4. Click {{%bold%}}Export{{%/bold%}}.

Catalyst will begin the project export process. The console will display the status of the export.


When the export is initialized, an {{%bold%}}Export ID{{%/bold%}} is generated for it automatically. You can use the Export ID to {{%link href=&#34;/en/cli/v1/export-and-import-projects/export-import-job-status/&#34; %}}check the status of the export job from the CLI{{%/link%}}. The console will also display other details of the export. After the export is complete, it will display a {{%bold%}}Download ZIP{{%/bold%}} link, where you can download the project ZIP file from.


If there were any issues in the export process and Catalyst was unable to export the project, the console will display a {{%bold%}}View Error Log{{%/bold%}} link.


You can click on this link to view the error details. You can resolve the error and export the project again.


#### Re-Export a Project

You can export a project again that was exported previously, if the ZIP download link has expired or if the project&#39;s components or code have been updated.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* Catalyst will always export the latest definitions and code of a project.

* If you re-export a project that you previously exported, the _Download ZIP_ link for the latest export of that project will only be available. This is because Catalyst only stores the latest export of a project, and none of its previous exports.
{{%/note%}}

To export a project again that was previously exported, click the ellipsis icon for the exported project, then click {{%bold%}}Export Again{{%/bold%}}.


The project will be exported in the same manner as described in the last section. You can then download the latest export using the {{%bold%}}Download ZIP{{%/bold%}} link.

### Import a Project

The IaC import option enables you to import a new Catalyst project from an existing project ZIP file. Catalyst will configure each component based on the definitions specified in the project-template JSON. The functions and client code will be populated in the project as well, if present. After the import job is completed, the new project will be available with the configurations and code populated in it.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* The source ZIP file containing the project definitions, and the functions and client code must be in the {{%link href=&#34;/en/cli/v1/export-and-import-projects/export-import-zip-file/&#34; %}}standard format{{%/link%}} to be imported.

* The project-template JSON file must be mandatorily present in the root of the ZIP file. A project cannot be imported without this file. The {{%badge%}}functions{{%/badge%}} or {{%badge%}}webclient{{%/badge%}} directories are not mandatory.

* You cannot import a project directly into the {{%link href=&#34;/en/deployment-and-billing/environments/development-environment&#34; %}}production environment{{%/link%}}.
{{%/note%}}

You can import a new project in the following way:

1. Navigate to {{%bold%}}Infrastructure as Code{{%/bold%}} under _General Settings_.&lt;br /&gt; 
2. Click {{%bold%}}Import New Project{{%/bold%}} from the _IaC Imports_ section.
3. Enter a name for the new project in the pop-up window. Select the source ZIP file of the project to be imported.&lt;br /&gt; 
4. Click {{%bold%}}Import{{%/bold%}}.

Catalyst will begin the project import process. The console will display the status of the process.


When the import is initialized, an {{%bold%}}Import ID{{%/bold%}} is generated for it automatically. You can use the Import ID to {{%link href=&#34;/en/cli/v1/export-and-import-projects/export-import-job-status/&#34; %}}check the status of the import job from the CLI{{%/link%}}. The console will also display other details of the import job.

If the import is successful, you will find a new project created in the console with the components configured based on the ZIP file. The console will display an {{%bold%}}Access Project{{%/bold%}} link for the import job. You can click this link to open the new project.


If there were any issues in the import process and Catalyst was unable to import the project, the console will display a {{%bold%}}View Error Log{{%/bold%}} link.


You can click on it to view the error details. You can resolve the error and import the project again.


--------------------------------------------------------------------------------
title: "Audit Logs"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.560Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/audit-logs/"
service: "All Services"
--------------------------------------------------------------------------------


# Audit Logs

### Introduction

The _Audit Logs_ section displays the logs of all the projects of your Catalyst account. It enables you to keep track of
a host of different activities performed in your projects by various collaborators.

Access to the audit logs is based on the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions&#34; %}}permissions{{%/link%}}granted to a {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators&#34; %}}project member&#39;s{{%/link%}} profile. That is, if the permission to access the Audit Logs is granted in the Editor or Viewer
access type for a project member, they will be able to view the logs in the console. An admin of a Catalyst account can
access all audit logs by default.

Audit Logs include two different types of logs:

* {{%bold%}}Console Logs:{{%/bold%}} Includes the logs of activities performed in various components and the
configurations of metadata. For example, if a new column is added in the Data Store, a rule is updated in Event
Listeners, or a cron job is deleted in your project, the details of these activities will be displayed in this section.
* {{%bold%}}Application Logs:{{%/bold%}} Includes the logs of activities performed at the application level, that is the
addition, modification, and deletion of sensitive data in the Data Store and File Store components. For example, if data
is inserted or updated into a column that is marked as sensitive, or a file is deleted from a folder marked as
sensitive, the details of these activities will be displayed in this section.

{{%note%}}{{%bold%}}Note:{{%/bold%}} 
Catalyst enables you to {{%link href=&#34;/en/cloud-scale/help/data-store/columns/#create-a-new-column&#34; %}}mark columns in the DataStore{{%/link%}} or {{%link href=&#34;/en/cloud-scale/help/file-store/implementation/#create-a-folder&#34; %}}folders in the File Store{{%/link%}} as &#34;sensitive&#34; while creating or updating them to adhere to all relevant and applicable data protection laws and privacy guidelines, such as {{%link href=&#34;https://gdpr-info.eu/&#34; %}}GDPR{{%/link%}} and {{%link href=&#34;https://www.hhs.gov/hipaa/index.html&#34; %}}HIPAA{{%/link%}} regulations, because user data can contain sensitive information. The application logs display all activities performed in these sensitive columns or folders to be in compliance with these data protection regulations.{{%/note%}}

Catalyst displays the logs of the last one year for all projects in the console. However, you can fetch logs from upto
six years ago by {{%link href=&#34;#export-logs&#34; %}}exporting them{{%/link%}}. This will generate a downloadable ZIP file that
will contain logs of the last six years.

### Console Logs

You can access _Audit Logs_ from the settings in your Catalyst console. As mentioned earlier, the console logs will only
include logs of component configurations such as cache, cron, or API Gateway configurations, and logs of metadata
activities, such as the creation or deletion of Data Store columns, Folder role permissions.


You can select the project for the console logs to be displayed from the {{%bold%}}_Project_{{%/bold%}} drop-down.

The _{{%bold%}}Features{{%/bold%}}_ drop-down shows the features that you can filter the logs based on, such as,
Datastore Table, Datastore Column, Cache, Sign-in Method, Email Domain, Table Row Permissions, etc.

You can filter the logs based on one of the three operations: Create, Update, or Delete, from the
{{%bold%}}_Operations_{{%/bold%}} drop-down. Click {{%bold%}}Apply{{%/bold%}} after you select the filters to view the
results.

The logs display details such as the date and time of the activity and the collaborator that performed the activity
besides the operation, feature, and project name.

{{%note%}}{{%bold%}}Note:{{%/bold%}} The console logs will only be applicable to the
{{%link href=&#34;/en/deployment-and-billing/environments/development-environment&#34; %}}development environment{{%/link%}} as component
configurations cannot be performed in the production environment.{{%/note%}}

### Application Logs

The application logs enable admins, and project members with the necessary permissions, to keep a track of all sensitive
user data, to comply with standard data protection laws and privacy guidelines.

These logs will therefore only display the following activities:

* Any creation, updation, or deletion of rows in a column marked as &#34;sensitive&#34; in the Data Store
* Any creation or deletion of files in a folder marked as &#34;sensitive&#34; in the File Store


Similar to the Console Logs, you can select the project for the application logs to be displayed from the
_{{%bold%}}Project{{%/bold%}}_ drop-down.

You can filter the feature as &#34;Datastore Row&#34; or &#34;File&#34; from the _{{%bold%}}Features{{%/bold%}}_ drop-down, and the
operation as Create, Update, or Delete, from the _{{%bold%}}Operations{{%/bold%}}_ drop-down to display only relevant
results.

Application logs are available in both development and production environments as sensitive data can be added, modified,
or removed in both. You can therefore also filter the logs based on the environment from the
_{{%bold%}}Environment{{%/bold%}}_ drop-down. Click {{%bold%}}Apply{{%/bold%}} after you select the filters to view the
results.

The logs display details such as the date and time of the activity and the collaborator that performed the activity
besides the operation, feature, and project name.

### Export Logs

You can export the logs of all projects in your account from upto six years ago and download a ZIP file of these logs
into your local system.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Only
{{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/#introduction&#34; %}}Catalyst account admins{{%/link%}} will
be able to view the Export Logs link in their console, and be able to export audit logs and download them. This feature
will not be available to project members.{{%/note%}}

1. Click {{%bold%}}Export Logs{{%/bold%}} to begin exporting.&lt;br /&gt; 

2. You can choose to export the {{%bold%}}Console Logs{{%/bold%}} or {{%bold%}}Application Logs{{%/bold%}}, or both, and click {{%bold%}}Export{{%/bold%}}.&lt;br /&gt; &lt;br /&gt; Catalyst will then begin the export process.&lt;br /&gt; 

3. You will receive a notification when the export is done. You will find an info at the bottom of your screen with the download link. You can download the logs from it.&lt;br /&gt; &lt;br /&gt; You can also open the Export Logs pop-up window again to access the download link.&lt;br /&gt; 

The downloaded ZIP file will contain individual CSV files of each year from the last six years, with 2 files per year indicating the first half and second half of the year respectively, of the console logs or application logs or both based on your choice.


For the current year, there will be separate CSV files of both the development and production environments for the application logs, and a single file for the console logs.

After you export logs for the first time, the download link of the last exported logs will always be shown in the _Export Logs_ pop-up window anytime you open it. You can download them again, if required.

--------------------------------------------------------------------------------
title: "General Settings"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.561Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/general-settings/"
service: "All Services"
--------------------------------------------------------------------------------


# General Settings

### Introduction

The _General_ section displays your project details, and enables you to change the timezone of your current project and also delete the project, if required. This section displays the project name, Project ID, your Catalyst account name, and the date, time, and the time zone of your project.


The {{%bold%}}Project ID{{%/bold%}} is the unique ID of your project that was created automatically during the project&#39;s creation. This ID is used to refer to your project in various CLI, SDK, and API operations.

You can access the General settings of any of your projects from this section, by changing the project using the dropdown list on the top. This will switch the active project in the console as well.


&lt;br&gt;

### Change the Time Zone of the Project

You can define and store a time zone for your project from this section, and this will override the default time zone set based on the data center you access. The time zone you set for your project here will be applicable across all components and features of your project. For example, the time shown for the function execution logs in the Logs component will be based on this time zone.

However, you can choose to change the time zone for individual components such as {{%link href=&#34;/en/cloud-scale/help/cron/implementation/&#34;%}}Cron{{%/link%}} and {{%link href=&#34;/en/devops/help/logs/access-logs/&#34;%}}Logs{{%/link%}} independently if you require, by configuring their time zones in their respective sections. The default time zone of the project will still remain the one that is configured under the General Settings.

1. You can also change the time zone of your Catalyst project by clicking the ellipsis icon, then clicking **Change Time Zone**.

2. Select your preferred time zone from the list displayed.

3. Click **Yes, Proceed** to continue.

The selected time zone will be reflected under the General Settings.

&lt;br&gt;

### Delete a Project

1. You can also delete your project from this page by clicking {{%bold%}}Delete Project{{%/bold%}}.
&lt;br /&gt; &lt;br /&gt;
2. Type &#34;DELETE&#34; in the pop-up window for confirmation, then click {{%bold%}}Confirm{{%/bold%}}.
&lt;br /&gt; &lt;br /&gt;

Your project and its resources will be permanently deleted from the console.

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* Deleting a project will delete all applications created in the project, which includes web, Android, iOS, Flutter apps. If you have deployed your project to production, the applications will be deleted from the live environment as well. You must therefore proceed with caution.

* You will also not be able to initialize this project from the CLI or perform API operations on it, after it is deleted.
{{%/note%}}


--------------------------------------------------------------------------------
title: "Integrations Settings"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.561Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/integrations-settings/"
service: "All Services"
--------------------------------------------------------------------------------


# Integrations Settings

### Introduction

The Integrations settings section enables you to configure and manage Catalyst integrations with other Zoho services or third-party services. Catalyst handles the backend processes involved in implementing the integrations solely, and enables you to easily integrate your Catalyst account with any of the available external services with a few steps from this section. You can view the details of the integrated accounts, modify them, and also delete the integrations permanently, if required from this section. 

Catalyst also provides you with the benefit of associating different accounts in the Zoho services for the {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34; %}}development and production environments{{%/link%}} environments of your project individually. You can add and manage integrations for both environments from this section.

Catalyst provides integration with the following Zoho and third-party services:
	
* {{%bold%}}{{%link href=&#34;https://www.zoho.com/en-in/crm/&#34; %}}Zoho CRM{{%/link%}}{{%/bold%}}
* {{%bold%}}{{%link href=&#34;https://openai.com/&#34; %}}OpenAI{{%/bold%}}{{%/link%}}
* {{%bold%}}{{%link href=&#34;https://github.com/&#34; %}}GitHub{{%/bold%}}{{%/link%}}
* {{%bold%}}{{%link href=&#34;https://about.gitlab.com//&#34; %}}GitLab{{%/bold%}}{{%/link%}}
* {{%bold%}}{{%link href=&#34;https://bitbucket.org/&#34; %}}Bitbucket{{%/bold%}}{{%/link%}}

### Zoho CRM Integration

The Zoho CRM integration allows you to establish a connection between your Catalyst project and your existing Zoho CRM accounts. This integration uses the {{%link href=&#34;/en/cloud-scale/help/event-listeners/zoho-event-listeners/&#34; %}}{{%bold%}}Zoho Event Listeners{{%/bold%}}{{%/link%}} to listen for events occurring in CRM and invoke the associated event functions upon their occurrence. 

You can add Catalyst integrations with your existing accounts in Zoho CRM directly, while configuring {{%link href=&#34;/en/cloud-scale/help/event-listeners/zoho-event-listeners/#create-a-rule-in-a-zoho-event-listener&#34; %}}event listener rules{{%/link%}}, or from the _Integrations_ settings section. You can also temporarily revoke a configured account, delete an account, or delete integration with an entire service from this section.

{{%note%}}{{%bold%}}Note:{{%/bold%}} 

* You must already have an account in Zoho CRM to be able to integrate it with Catalyst. You can have any tier or edition of account in these services, such as the Standard, Professional, or even the free tiers.

* Please refer to the {{%link href=&#34;/en/cloud-scale/help/event-listeners/introduction/&#34; %}}Event Listeners help document{{%/link%}} for details about various types of event listeners available in Catalyst, and about configuring event listener rules.{{%/note%}}

#### Add an Integration with Zoho CRM in the Development Environment

To add a Catalyst integration with an account in Zoho CRM for the development environment:


1. Navigate to {{%bold%}}Integrations{{%/bold%}} under _General Settings_ from the settings in the console. Click on {{%bold%}}Zoho CRM{{%/bold%}} to integrate an account in it with Catalyst.&lt;br /&gt; &lt;br /&gt;


2. Click {{%bold%}}Add account{{%/bold%}} from the _Development_ tab for the service. &lt;br /&gt; &lt;br /&gt;This will redirect you to a permissions page where you can add an account already created in CRM.

3. Select an account from the drop-down to integrate Catalyst with. Then, click {{%bold%}}Accept{{%/bold%}} to provide the request permissions to Catalyst. &lt;br /&gt; &lt;br /&gt;Catalyst will schedule an org synchronization with the newly integrated account. You will be alerted with a pop-up window.  &lt;br /&gt; &lt;br /&gt;The synchronization will take 2-4 minutes to complete. The service page in the _Integrations_ settings will display the status. &lt;br /&gt; &lt;br /&gt;After the sync is completed, the status will be shown as _Granted_, indicating Catalyst&#39;s authorization to access this service account for the allowed permissions. &lt;br /&gt; &lt;br /&gt;


You will now be able to associate event listener rules with this account through Zoho event listeners. This account will be displayed as an option to integrate with, while {{%link href=&#34;/en/cloud-scale/help/event-listeners/zoho-event-listeners/#create-a-rule-in-a-zoho-event-listener&#34; %}}configuring a rule{{%/link%}}. The console will display all rules associated with a service account after you configure them. 

&lt;br /&gt; &lt;br /&gt;


You can also click on the account name to view the details.

&lt;br /&gt; &lt;br /&gt;

&lt;br&gt;


#### Add an Integration with Zoho CRM in the Production Environment

Catalyst requires you to configure accounts for the production environment in the supported Zoho services for all existing Zoho event listener rules before or when you deploy your project to production. 

You can manually add integrations with your Zoho CRM account for the production environment in _Integrations_ settings. That is, you can configure production account even before you deploy your project to production and manage this account from the settings.

To add a Catalyst integration with a Zoho CRM account for the production environment:

1. Click on {{%bold%}}Zoho CRM{{%/bold%}} from the Integrations settings page, then click the {{%bold%}}Production{{%/bold%}} tab.&lt;br /&gt; &lt;br /&gt;

2. Click {{%bold%}}Add account{{%/bold%}} from the _Production_ section. 

3. Select a project from the drop-down to add the integration for. Because _General_ settings are common for all projects, you will need to specify the project through this step. Click {{%bold%}}Add account{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;

4. You can then select an account from the drop-down to integrate Catalyst with, and click {{%bold%}}Accept{{%/bold%}} to provide the requested permissions.&lt;br /&gt; &lt;br /&gt;


The process will be the same as [adding an integration in the development environment](#add-an-integration-in-the-development-environment) from here on. An org synchronization will be scheduled and the status of the sync will be displayed in the _Production_ section of the service. 

&lt;br /&gt; &lt;br /&gt;

The rules associated with the account in production will also be displayed after they are configured. 

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst will ask you to associate each existing event listener rule with a production account before or during your project {{%link href=&#34;/en/deployment-and-billing/environments/deployment-types/&#34; %}}deployment to production{{%/link%}}. This will be handled by a pop-up that will ask you to associate production accounts for each rule during the deployment process. The pop-up will display the accounts that have been added in the Production section, and will also enable you to add new accounts. You can refer to {{%link href=&#34;/en/cloud-scale/help/event-listeners/zoho-event-listeners/#configuring-accounts-for-the-production-environment&#34; %}}this Event Listeners help section{{%/link%}} for details.{{%/note%}}

&lt;br&gt;

#### Revoke an Integrated Account with Zoho CRM


Catalyst enables you to revoke the permissions granted for it to access an account in Zoho CRM that was integrated for the development or production environment. Revoking is a temporary hold that will stop the event listener rules associated with that account from being executed, until the permissions are granted again.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You will still be able to add event listener rules associating with an account even after you revoke that account. However, the rules will not get executed until the permissions are granted again. {{%/note%}}

To revoke an integrated account in the development or production environment:

1. Click the ellipsis icon for the account, then click {{%bold%}}Revoke{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;

2. Click {{%bold%}}Yes, Proceed{{%/bold%}} in the confirmation pop-up.&lt;br /&gt; &lt;br /&gt;

The status of the account will be shown as _Revoked_. You can grant permissions to access this account again by clicking the ellipsis icon, then clicking **Grant**.

&lt;br /&gt;

The rules associated with this account will then be executed as configured.


&lt;br&gt;


#### Delete an Integrated Account with Zoho CRM

You can permanently delete an account in Zoho CRM that you integrated with Catalyst for the development or production environment. 

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* If you delete an account that has been configured with any Zoho event listener rules, all associations with the rules will be removed. The rules will be disabled and will therefore not be executed until you configure them again. You must ensure that you do not delete any accounts that are associated with any active event listeners.

* If you add a previously deleted account again, the rules that were associated with that account earlier will not be re-associated with it again automatically. You will need to manually re-configure the rules.{{%/note%}}

&lt;br&gt;

To delete an integrated account in the development or production environment:


1. Click the ellipsis icon for the account, then click {{%bold%}}Delete{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;

2. Click {{%bold%}}Yes, Proceed{{%/bold%}} in the confirmation pop-up. &lt;br /&gt; &lt;br /&gt;


The account will be removed from the service. The Event Listeners component will display a &#34;Configuration Needed&#34; error for all rules that were associated with the deleted account.

&lt;br /&gt;

You can associate these rules with a different account by clicking on the error message. You can also integrate the deleted account again in the same manner as explained [earlier](#add-an-integration-in-the-production-environment).


#### Delete Zoho CRM Service

Catalyst enables you to remove all accounts in Zoho CRM by deleting the entire service. This action will unlink all added accounts in that service in both the development and production environments. 


{{%note%}}{{%bold%}}Note:{{%/bold%}}

If you delete a Zoho service:
* The _Integrations_ settings will still display the service in its index page. However, all accounts and configurations added for that service will be removed permanently. 
* All event listener rules associated with the accounts in that service will be disabled and will therefore not be executed until you configure them again. 

You must therefore ensure that you do not delete a service that includes accounts that are associated with any active event listeners.{{%/note%}}


To delete a Zoho service:

1. Click the ellipsis icon for the service from the top-right corner, then click {{%bold%}}Delete{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;


2. Type &#34;DELETE&#34; for confirmation, then click {{%bold%}}Confirm{{%/bold%}} in the pop-up.&lt;br /&gt; &lt;br /&gt;


All integrated accounts in the service will be removed from it. The _Event Listeners_ component will display a &#34;Configuration Needed&#34; error for all rules that were associated with the accounts from the deleted service. You can associate these rules with a different service or integrate new accounts in the service.

&lt;br&gt;


### OpenAI Integration

Catalyst integrates with {{%link href=&#34;https://openai.com/&#34; %}}OpenAI{{%/link%}} to provide a host of AI-powered automation features that aid in your software development journey through Zia AI Assistant. These features include: Code Converter, Code Generator, Code Debugger, Code Docs Generator, and Test Case Generator. Refer to the {{%link href=&#34;/en/integrations/openai-integration/introduction/&#34; %}}Zia AI Assistant help docs{{%/link%}} to learn more.

Catalyst enables users to perform these supported operations through OpenAI&#39;s API endpoint. To avail the API through Catalyst, you will be required to generate an API secret key with OpenAI and configure it in Catalyst. This key allows Catalyst users to prompt the AI and obtain results, and authenticates these operations. 

Catalyst&#39;s integration with OpenAI servers is built upon a **Bring Your Own Key (BYOK)** configuration that requires  Catalyst user to register for an API key with OpenAI through their OpenAI account, and configure it in Catalyst to authenticate their actions. There are no API keys provided by Zoho for the integration. 

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can configure a single API key for an entire {{%link href=&#34;/en/getting-started/catalyst-organizations/&#34; %}}Catalyst organization{{%/link%}}. Each {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/collaborators/&#34; %}}Catalyst collaborator{{%/link%}} need not register for or configure their own individual key. For example, if the Super Admin of a Catalyst org registers for an API key with OpenAI and configures it in Catalyst for that org, all other admins and project members of that org can avail OpenAI services with that key. {{%/note%}}

After you configure the key in Catalyst, all the input prompts you enter in Catalyst Zia AI, such as in the Code Converter, Code Generator, etc., will be shared with OpenAI, and the result will be fetched and rendered in Catalyst, as received from OpenAI without any manipulation or customization.

&lt;br&gt;

#### Configure API Key for OpenAI Integration


The steps to generate an API secret key for your OpenAI account and configure the key for your Catalyst account are described below.

1. Click **OpenAI Integration** from the *Integrations* settings section. 

    
2. Click **OpenAI Integration**. 

3. You will be asked to configure the OpenAI API Key. If you had previously configured an OpenAI key with another Zoho product with your Zoho account, or in Catalyst, select the **Existing API Key** option. Else, select the **New API Key** option to configure a new key. 

    
4. If you select the *New API Key option*, follow the steps displayed in the console to generate a new secret key from the OpenAI platform. After the key is generated, paste it in the text box to configure it in Catalyst. Then, click **Configure Key**.

    If you had selected the *Existing API Key* option, directly click **Configure Key**.

5. Read the *Data Privacy Notice* and additionally go through *OpenAI&#39;s Terms and Conditions* from the link provided. Then, click **Proceed**.

    
&lt;br&gt;

The API key will be configured with Catalyst. You can now refer to the details of the API key, as well as its status and usage from this section. 


&lt;br&gt;

#### Edit API Key

Catalyst enables you to easily edit the OpenAI API key that you have configured and update it as required. This is beneficial in case you re-generate your API secret key or create a new one for your OpenAI account at any point of time. 

To edit the configured API key in Catalyst:

1. In the **OpenAI Integration** section of the Integrations settings in your console, click the ellipsis icon, then click **Edit**.


2. Modify your API key, then click **Update** to confirm.


&lt;br&gt;

#### Disable API Key

If you don&#39;t require an active configuration of an OpenAI API key in Catalyst for any specific reason, you can disable the key for as long as you need. If the API key is disabled, you will not be able to access any of OpenAI&#39;s features, such as Code Generator or Test Case Generator, or provide any prompts. 
You will be able to access the Zia AI features in Catalyst only after you enable the API key again. 

{{%note%}}{{%bold%}}Note:{{%/bold%}}

* Catalyst currently does not provide the functionality to permanently delete an OpenAI integration by deleting the API key. You can disable the configured key and re-enable it, as required. You can also update the key to configure a newly generated key.

* Catalyst does not support the configuration of multiple API keys simultaneously. Therefore, you will not be able to disable a key and configure another one. {{%/note%}}
&lt;br&gt;

To disable the configured API key in Catalyst:

1. In the **OpenAI Integration** section of the *Integrations* settings in your console, click the ellipsis icon, then click **Disable**.


2. Click **Yes, Proceed** in the confirmation pop-up.


The key will be shown as disabled.


&lt;br&gt;

You can re-enable a disabled key in a similar manner:

1. In the **OpenAI Integration** section, click the ellipsis icon, then click **Enable**.


2. Click **Yes, Proceed** in the confirmation pop-up.


### GitHub Integration

The GitHub Integration feature allows you to connect your {{%bold%}}{{%link href=&#34;https://github.com/&#34; %}}GitHub{{%/bold%}}{{%/link%}} account with Catalyst seamlessly, enabling access to the repositories(both public and private), organizations and teams, webhooks, and personal user data. With this integration, you can perform essential operations such as committing, pushing, and pulling code directly within Catalyst. 

#### Supported Services

This integration is available for the following Catalyst service:

* **{{%link href=&#34;/en/pipelines/&#34; %}}Catalyst Pipelines{{%/link%}}**

{{%note%}}{{%bold%}}Note:{{%/bold%}} 

1. You can explore our new service, {{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}Catalyst Pipelines{{%/link%}}, an advanced version of the Git component. Catalyst Pipelines enables you to define the entire end-to-end build-to-deployment workflow using commands in a YAML file. To learn more, refer to the {{%link href=&#34;/en/pipelines/help/pipelines/introduction/&#34; %}}help documentation{{%/link%}}.


2. Please note that this service is currently part of our early access program. If you haven&#39;t gained access yet, you can request it directly through {{%link href=&#34;https://forms.zohopublic.com/zohocorporation/form/CatalystbyZohoPartnerEarlyaccess/formperma/bc3yQ4vaPEMxmwRhkTvdKemwiM1ZY400Oj74EuRCImU&#34; %}}this form{{%/link%}}.

{{%/note%}}

#### Benefits of Integration

**Catalyst Pipelines**

{{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}Catalyst Pipelines{{%/link%}} is the CI/CD service that helps to streamline and automate your software development and deployment process. By integrating your GitHub account with Catalyst Pipelines, the service automatically clones the code from your selected repository. When the pipeline is triggered, the defined commands in your {{%link href=&#34;/en/pipelines/help/catalyst-pipelines.yaml/introduction&#34; %}}YAML configuration{{%/link%}}
are executed on the cloned codebase seamlessly, ensuring smooth automation of your workflows from build to deployment.. You can learn more about pipelines in {{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}this help documentation{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}}
This integration functions in accordance with GitHub&#39;s terms and conditions and is not exclusive to Catalyst.{{%/note%}}

#### Integrate a GitHub Account

1. Click on the **GitHub** tile.


2. Click **Add Account** to integrate your GitHub account with Catalyst.


3. Click **Agree** to accept the terms and conditions of GitHub. 


4. Provide your username or email address and the password of your GitHub account. Click **Sign in**. 


5. Click **Authorize ZohoCorporation** to proceed.


6. The integration is successful, and the GitHub account will be listed as shown in the screenshot below. 


You can add any number of accounts by clicking on the **Add Account** button.

#### Revoke a GitHub Account

To revoke a GitHub account, please make sure to follow the below mentioned steps:

1. Click on the ellipsis icon on the right corner and then click **Revoke**.


2. Click Revoke to delete the integration permanently. 


{{%note%}}{{%bold%}}Note:{{%/bold%}}You can add the same Git account again to enable the integration at any point of time.{{%/note%}} 

### GitLab Integration

The GitLab Integration feature allows you to connect your {{%bold%}}{{%link href=&#34;https://about.gitlab.com//&#34; %}}GitLab{{%/bold%}}{{%/link%}} account with Catalyst seamlessly, enabling access to the repositories (both public and private), organizations and teams, webhooks, and personal user data. With this integration, you can perform essential operations such as committing, pushing, and pulling code directly within Catalyst.

#### Supported Services

This integration is available for the following Catalyst service:

* **{{%link href=&#34;/en/pipelines/&#34; %}}Catalyst Pipelines{{%/link%}}**

{{%note%}}{{%bold%}}Note:{{%/bold%}} 

1. You can explore our new service, {{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}Catalyst Pipelines{{%/link%}}, an advanced version of the Git component. Catalyst Pipelines enables you to define the entire end-to-end build-to-deployment workflow using commands in a YAML file. To learn more, refer to the {{%link href=&#34;/en/pipelines/help/pipelines/introduction/&#34; %}}help documentation{{%/link%}}.


2. Please note that this service is currently part of our early access program. If you haven&#39;t gained access yet, you can request it directly through {{%link href=&#34;https://forms.zohopublic.com/zohocorporation/form/CatalystbyZohoPartnerEarlyaccess/formperma/bc3yQ4vaPEMxmwRhkTvdKemwiM1ZY400Oj74EuRCImU&#34; %}}this form{{%/link%}}.

{{%/note%}}

#### Benefits of Integration

**Catalyst Pipelines**

{{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}Catalyst Pipelines{{%/link%}} is the CI/CD service that helps to streamline and automate your software development and deployment process. By integrating your GitLab account with Catalyst Pipelines, the service automatically clones the code from your selected repository. When the pipeline is triggered, the defined commands in your {{%link href=&#34;/en/pipelines/help/catalyst-pipelines.yaml/introduction&#34; %}}YAML configuration{{%/link%}}
are executed on the cloned codebase seamlessly, ensuring smooth automation of your workflows from build to deployment.. You can learn more about pipelines in {{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}this help documentation{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}}
This integration functions in accordance with GitLab&#39;s terms and conditions and is not exclusive to Catalyst.{{%/note%}}

#### Integrate a GitLab Account

1. Click on the **GitLab** tile.


2. Click **Add Account** to integrate your GitLab account with Catalyst.


3. Click **Agree** to accept the terms and conditions of GitLab. 


4. Provide your username or email address and the password of your GitLab account. Click **Sign in**. You can also sign in using any providers as shown in the screenshot below.


5. Click **Authorize Zoho Catalyst - US** to proceed.


6. The integration is successful, and the GitLab account will be listed as shown in the screenshot below. 


You can add any number of accounts by clicking on the **Add Account** button.

#### Revoke a GitLab Account

To revoke a GitLab account, please make sure to follow the below mentioned steps:

1. Click on the ellipsis icon on the right corner and then click **Revoke**.


2. Click Revoke to delete the integration permanently. 


{{%note%}}{{%bold%}}Note:{{%/bold%}}You can add the same Git account again to enable the integration at any point of time.{{%/note%}} 

### Bitbucket Integration

The Bitbucket Integration feature allows you to connect your {{%bold%}}{{%link href=&#34;https://bitbucket.org/&#34; %}}Bitbucket{{%/bold%}}{{%/link%}} account with Catalyst seamlessly, enabling access to the repositories (both public and private), organizations and teams, webhooks, and personal user data. With this integration, you can perform essential operations such as committing, pushing, and pulling code directly within Catalyst.

#### Supported Services

This integration is available for the following Catalyst service:

* **{{%link href=&#34;/en/pipelines/&#34; %}}Catalyst Pipelines{{%/link%}}**

{{%note%}}{{%bold%}}Note:{{%/bold%}} 

1. You can explore our new service, {{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}Catalyst Pipelines{{%/link%}}, an advanced version of the Git component. Catalyst Pipelines enables you to define the entire end-to-end build-to-deployment workflow using commands in a YAML file. To learn more, refer to the {{%link href=&#34;/en/pipelines/help/pipelines/introduction/&#34; %}}help documentation{{%/link%}}.


2. Please note that this service is currently part of our early access program. If you haven&#39;t gained access yet, you can request it directly through {{%link href=&#34;https://forms.zohopublic.com/zohocorporation/form/CatalystbyZohoPartnerEarlyaccess/formperma/bc3yQ4vaPEMxmwRhkTvdKemwiM1ZY400Oj74EuRCImU&#34; %}}this form{{%/link%}}.

{{%/note%}}

#### Benefits of Integration

**Catalyst Pipelines**

{{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}Catalyst Pipelines{{%/link%}} is the CI/CD service that helps to streamline and automate your software development and deployment process. By integrating your Bitbucket account with Catalyst Pipelines, the service automatically clones the code from your selected repository. When the pipeline is triggered, the defined commands in your {{%link href=&#34;/en/pipelines/help/catalyst-pipelines.yaml/introduction&#34; %}}YAML configuration{{%/link%}}
are executed on the cloned codebase seamlessly, ensuring smooth automation of your workflows from build to deployment.. You can learn more about pipelines in {{%link href=&#34;/en/pipelines/getting-started/introduction/&#34; %}}this help documentation{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}}
This integration functions in accordance with Bitbucket&#39;s terms and conditions and is not exclusive to Catalyst.{{%/note%}}

#### Integrate a Bitbucket Account

1. Click on the **Bitbucket** tile.


2. Click **Add Account** to integrate your Bitbucket account with Catalyst.


3. Click **Agree** to accept the terms and conditions of Bitbucket. 


4. Provide your username or email address and the password of your Bitbucket account and click **Continue**. You can also sign-in using any providers as shown in the screenshot below.


5. The integration is successful, and the Bitbucket account will be listed as shown in the screenshot below. 


You can add any number of accounts by clicking on the **Add Account** button.

#### Revoke a Bitbucket Account

To revoke a Bitbucket account, please make sure to follow the below mentioned steps:

1. Click on the ellipsis icon on the right corner and then click **Revoke**.


2. Click Revoke to delete the integration permanently. 


{{%note%}}{{%bold%}}Note:{{%/bold%}}You can add the same Git account again to enable the integration at any point of time.{{%/note%}} 


--------------------------------------------------------------------------------
title: "Developer Tools"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.563Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/developer-tools/"
service: "All Services"
--------------------------------------------------------------------------------


# Developer Tools

### Introduction

The _Developer Tools_ section in settings contains the links to access and download the SDK packages offered by Catalyst the applications in your project.


You can develop web, iOS, and Android applications using Catalyst. To associate a project with one of these platforms, you must download or initialize its SDK package and use it in your application building process.

You can develop the backend of your application and include server side functions in the Java, Node.js or Python environments. You must download or initialize the Java SDK or Node.js SDK or Python SDK packages in your application&#39;s code.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can select a different project using the dropdown list at the top and download the SDKs for that project. {{%/note%}}

The steps to download or initialize each developer tool are described in this help page.

&lt;br&gt;

### Java SDK

When you click {{%bold%}}Java{{%/bold%}} from this section, it will automatically initiate the download of the Catalyst Java SDK package. A zip folder containing the Java SDK JAR files will be downloaded to your system.

&lt;br /&gt;

You must include this Java SDK package in your Java server side functions and initialize the project. You can then obtain instances of each component and code the functionalities of your application.

For detailed help on initializing the Catalyst Java SDK package, its features, and sample code snippets for various components, refer to the {{%link href=&#34;/en/sdk/java/v1/overview/&#34; %}}**Java SDK documentation**{{%/link%}}.

&lt;br&gt;

### Node.js SDK

When you click {{%bold%}}Node.js{{%/bold%}} from the _Developer Tools_ section, a pop-up window will open from which you can copy the command to install the Catalyst Node SDK package in your system using your terminal.


You must execute this command from the {{%link href=&#34;/en/cli/v1/project-directory-structure/introduction&#34; %}}project directory of your application{{%/link%}}, after you {{%link href=&#34;/en/getting-started/installing-catalyst-cli/&#34; %}}install Catalyst CLI{{%/link%}} and {{%link href=&#34;/en/cli/v1/initialize-resources/introduction/&#34; %}}associate the directory with a project{{%/link%}}. Alternatively you can execute {{%badge%}}$ npm install --save zcatalyst-sdk-node{{%/badge%}} to save it in your {{%badge%}}package.json{{%/badge%}}.

The Node.js SDK package will be installed to the directory as a node module. You can then initialize the SDK in your Node.js server side functions, and code the backend of your application.

For detailed help on initializing the Catalyst Node.js SDK package, its features, and sample code snippets for various components, refer to the {{%link href=&#34;/en/sdk/nodejs/v2/overview/&#34; %}}**Node.js SDK documentation**{{%/link%}}.

&lt;br&gt;

### Python SDK

When you click {{%bold%}}Python{{%/bold%}} from the _Developer Tools_ section, a pop-up window will open from which you can copy the command to install the Catalyst Python SDK package in your system using your terminal. 


You can execute this command from any location in your local, after you {{%link href=&#34;/en/getting-started/installing-catalyst-cli/&#34; %}}install Catalyst CLI{{%/link%}} and {{%link href=&#34;/en/cli/v1/initialize-resources/introduction/&#34; %}}associate the directory with a project{{%/link%}}.

The Python SDK package will be installed to the directory and then you can initialize the SDK in your Python server side functions, and code the backend of your application.

For detailed help on initializing the Catalyst Python SDK package, its features, and sample code snippets for various components, refer to the {{%link href=&#34;/en/sdk/python/v1/overview/&#34; %}}**Python SDK documentation**{{%/link%}}.

&lt;br&gt;

### Web SDK

When you click {{%bold%}}Web{{%/bold%}}, a pop-up window will open, from which you can copy the code to initialize the Web SDK for your project.

&lt;br /&gt;

You must paste the copied code in the main script of your application. You can enable user login for your application and embed the sign-in form as an iFrame, by passing the div of the login element in {{%badge%}}catalyst.auth.signIn(){{%/badge%}}.

This code refers to an {{%badge%}}init.js{{%/badge%}} file which will automatically populate the essential details of your project, such as the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/general-settings&#34; %}}Project ID{{%/link%}} and {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/environment-settings&#34; %}}ZAID{{%/link%}} for the environment you are working on. For detailed help on initializing the Catalyst Web SDK package, its features, and sample code snippets for various components, refer to the {{%link href=&#34;/en/sdk/web/v4/overview/&#34; %}}**Web SDK documentation**{{%/link%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}} You can also access an older version (v 1.0.0) of the web initialization script from the _Sign-in Method_ section in Authentication. Refer to the {{%link href=&#34;/en/cloud-scale/help/authentication/introduction/#implement-the-sign-in-script-of-an-older-version&#34; %}}Sign-in Method help page{{%/link%}} for details.{{%/note%}}

&lt;br&gt;

### Android and iOS SDKs

You can currently host one Android app and one iOS app for each project in Catalyst.

You can create a package for the Android or iOS app in the _Developer Tools_ section, and download the configuration file provided by Catalyst for your mobile app. You must then include this file in the folder structure of your Android or iOS app.

For detailed information on the Android and iOS SDK packages, the configuration file structure, and sample code snippets for various components, refer to the {{%bold%}}{{%link href=&#34;/en/sdk/android/v2/overview/&#34; %}}Android SDK documentation{{%/link%}}{{%/bold%}} or {{%bold%}}{{%link href=&#34;/en/sdk/ios/v2/overview/&#34; %}}iOS SDK documentation{{%/link%}}{{%/bold%}}.

{{%note%}}{{%bold%}}Note:{{%/bold%}} The permission to create or delete a mobile SDK package is based on the {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions/#permissions&#34; %}}role that a project member is associated with{{%/link%}}. An admin of a Catalyst account can create or delete packages in all projects by default. Any collaborator can view the details of the packages or download the configuration files.{{%/note%}}

#### Create a Mobile SDK Package

To create a mobile SDK package for your mobile app in Catalyst:

1. Click the {{%bold%}}Android{{%/bold%}} or {{%bold%}}iOS{{%/bold%}} tiles depending on the SDK you need. Alternatively, you can click the {{%bold%}}Add Package{{%/bold%}} button below.&lt;br /&gt; &lt;br /&gt; This will open a pop-up window. You can select the mobile OS from the pop-up as well.
2. Enter an Android or iOS package name that will uniquely identify the package. Provide the URL to redirect the end-user to after they log in to the mobile app, as the Redirect URL.
&lt;br /&gt; &lt;br /&gt; The values that you enter here will be auto-filled in the configuration files in the SDK package.
{{%note%}}{{%bold%}}Note:{{%/bold%}} A package name will be uniquely associated with that OS. Therefore, you cannot create packages with the same name for both Android and iOS apps. You must provide unique values.{{%/note%}}

3. Click {{%bold%}}Create{{%/bold%}} to create the mobile SDK package.

4. The console will then display a window from where you can download the configuration file. Click {{%bold%}}Download{{%/bold%}} to download the file.&lt;br /&gt; &lt;br /&gt;
{{%note%}}{{%bold%}}

Note:{{%/bold%}} When you create a package, only the development environment&#39;s configuration file will be available for download initially, irrespective of the environment you are currently working in. You can download the configuration files for any environment any time after the package is created. This is explained in the {{%link href=&#34;#download-the-configuration-file-for-a-mobile-sdk-package&#34; %}}next section{{%/link%}}.{{%/note%}}

The _Developer Tools_ section will display the mobile SDK packages you create for your project.

After you develop the mobile app, you can host it in Catalyst and distribute it using {{%link href=&#34;/en/cloud-scale/help/mobile-device-management/introduction&#34; %}}Mobile Device Management{{%/link%}}.

#### Download the Configuration file for a Mobile SDK Package

You can download the development or production configuration file for a mobile SDK package any time in the following way:

1. Click on the package displayed in the _Mobile SDK_ section.&lt;br /&gt; &lt;br /&gt; This will open a window with the details of the package, and the option to download the development or production configuration files. The value for the environment variable, as well as other variables such as {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/environment-settings&#34; %}}ZAID{{%/link%}}, will be populated accordingly in the files of different environments.
2. Click {{%bold%}}Download{{%/bold%}} in the required environment&#39;s tab to download the file.&lt;br /&gt; &lt;br /&gt; If you have not {{%link href=&#34;/en/deployment-and-billing/environments/production-environment&#34; %}}deployed the app to Production{{%/link%}} yet, you must first do so to access the production configuration file.
&lt;br /&gt; &lt;br /&gt;

Refer to the {{%link href=&#34;/en/sdk/android/v2/setup/&#34; %}}Android{{%/link%}} and {{%link href=&#34;/en/sdk/ios/v2/setup/&#34; %}}iOS{{%/link%}} SDK documentations for steps on including the file in your app&#39;s structure.

#### Delete a Mobile SDK Package

Deleting a mobile SDK package from the Developer Tools section will delete the mobile app from both the Development and Production environments. Your app will therefore become inaccessible to the production end-users. You will need to proceed with caution before deleting an app&#39;s package.

You can delete a mobile SDK package that you created from this section in the following way:

1. Click on the ellipsis icon next to the mobile SDK package, then click {{%bold%}}Delete{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;
2. Enter the package name again to confirm the action, then click {{%bold%}}Confirm{{%/bold%}}.&lt;br /&gt; &lt;br /&gt;

--------------------------------------------------------------------------------
title: "Environment Settings"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.564Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/environment-settings/"
service: "All Services"
--------------------------------------------------------------------------------


# Environment Settings

### Introduction

Catalyst provides two work environments in the Catalyst web console for developing your applications:

1. {{%bold%}}Development:{{%/bold%}} Enables you to create, configure, test, and host Catalyst features and components
in a local development mode, similar to a sandbox
2. {{%bold%}}Production:{{%/bold%}} Live mode that is accessible to the end users of your application, when you deploy
your application from the Development environment

You can learn about the Catalyst environments in detail from the
{{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34; %}}**Environments help page**{{%/link%}}.

The _Environments_ section in settings provides you environment-specific information about your project, and also
enables you to perform deployments between both the environments.

&lt;br /&gt;

The permissions to access the production environment, enable or disable production for a Catalyst application, and perform deployments is granted to a project member {{%link href=&#34;/en/getting-started/set-up-a-catalyst-project/profiles-and-permissions/#permissions&#34; %}}based on their profile{{%/link%}}. An admin of a Catalyst account has these permissions by default.

### General Tab

The following environment-specific information about your project is displayed under the _General_ tab:

* {{%bold%}}ZAID{{%/bold%}}: The unique identifier that maps an application to a project. The ZAID is different in the Development and Production environments of a project.
* {{%bold%}}API Key:{{%/bold%}} An authentication key for the API Gateway feature, that is common for the Development environment of all your projects, but different for the Production environments of each project. You can learn more about it from the {{%link href=&#34;/en/cloud-scale/help/api-gateway/key-concepts/#authentication-request-processor&#34; %}}API Gateway help page{{%/link%}}.
* {{%bold%}}Application URL:{{%/bold%}} The default URL of your Catalyst application that is automatically generated when you host a web client in your Catalyst project. The URL is generated for the Development environment when you host your application. After you deploy your application to Production, a Production URL is generated. The Development and Production URLs slightly differ in their formats. Both URLs contain the same:&lt;br /&gt;
   * {{%bold%}}Project Domain Name:{{%/bold%}} The unique domain name that is generated for your project when you host it in {{%link href=&#34;/en/cloud-scale/help/web-client-hosting/implementation/#host-a-web-application&#34; %}}Web Client Hosting{{%/link%}}. Example: _shipmenttracking-57673975_.

   * {{%bold%}}Domain Name:{{%/bold%}} The domain for all the Catalyst applications you host, which is{{%bold%}}catalystserverless.com{{%/bold%}}&#39;.However, the Development web app URL also contains the {{%bold%}}environment type{{%/bold%}}, and its value is {{%badge%}}development{{%/badge%}}. For example, &#39;_https://shipmenttracking-57673975.{{%bold%}}development{{%/bold%}}.catalystserverless.com_&#39;.
    
    The environment type is not specified in the Production URL. That is, the production URL will be &#39;_https://shipmenttracking-57673975.catalystserverless.com_&#39;.


### Deployments Tab

The _Deployments_ tab in the _Environments_ settings enables you to deploy your Catalyst project from one environment to the other, and manage the deployments.


You can learn about deploying your project in detail from the {{%link href=&#34;/en/deployment-and-billing/environments/introduction/&#34; %}}Environments help page{{%/link%}}.


--------------------------------------------------------------------------------
title: "Push Notifications Settings"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.564Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/push-notifications-settings/"
service: "All Services"
--------------------------------------------------------------------------------


# Push Notifications Settings

The _Push Notifications_ section in settings enables you to configure push notifications for the iOS app hosted in your
project. You can easily authenticate your app&#39;s APNs configuration with Catalyst, and allow it to forward the push
messages you create to Apple on your behalf and fetch the response.


You must provide the necessary information to enrol for Catalyst Push Notification services, and upload the APNS certificate of your iOS app.

You can learn about the key concepts, architecture, and the detailed step-by-step configuration procedure of iOS push notifications from the {{%link href=&#34;/en/cloud-scale/help/push-notifications/ios&#34; %}}**Push Notifications help page**{{%/link%}}.

--------------------------------------------------------------------------------
title: "Billing Settings"
description: "Catalyst settings allow you to configure, personalize, and set up features that are relevant to your Catalyst project and your console, from adding collaborators for your project to managing payments and billing for your account."
last_updated: "2026-03-18T07:41:08.564Z"
source: "https://docs.catalyst.zoho.com/en/getting-started/set-up-a-catalyst-project/billing-settings/"
service: "All Services"
--------------------------------------------------------------------------------


# Billing Settings

The _Billing_ section in settings enables you to manage the billing and payment for your Catalyst account.

{{%note%}}{{%bold%}}Note:{{%/bold%}} Catalyst enables you to choose between two different pricing models. The billing data will be available after you {{%link href=&#34;/en/deployment-and-billing/environments/&#34; %}}deploy{{%/link%}} atleast one project to production in the {{%link href=&#34;/en/deployment-and-billing/billing/pay-as-you-go-model/&#34; %}}pay-as-you-go pricing model{{%/link%}}. If you had opted for the {{%link href=&#34;/en/deployment-and-billing/billing/subscription-model/&#34; %}}subscription pricing model{{%/link%}}, the billing data will be available as soon as your subscription is confirmed.{{%/note%}}

You can set up and manage payments, keep a track of your Catalyst usage, view reports and cost breakdowns, check
forecasts, create budgets, and more from this section.


You can learn about the Billing settings and Catalyst payments in detail from the {{%link href=&#34;/en/deployment-and-billing/billing/billing-settings&#34; %}}**Billing help page**{{%/link%}}.