Zoho bigin | Composio Docs

Overview

SLUG: ZOHO_BIGIN

Description

Zoho Bigin is a simplified CRM solution from Zoho tailored for small businesses, focusing on pipeline tracking and relationship management

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to ZohoBigin.modules.ALL,ZohoBigin.users.ALL

bearer_token

string

suffix.one

stringRequired

Connecting to Zoho bigin

Create an auth config

Use the dashboard to create an auth config for the Zoho bigin toolkit. This allows you to connect multiple Zoho bigin accounts to Composio for agents to use.

Select App

Navigate to [Zoho bigin](https://platform.composio.dev/marketplace/Zoho bigin).

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Zoho bigin Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1 from composio import Composio
2 
3 # Replace these with your actual values
4 zoho_bigin_auth_config_id = "ac_YOUR_ZOHO_BIGIN_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/application
6 
7 composio = Composio()
8 
9 
10 def authenticate_toolkit(user_id: str, auth_config_id: str):
11     connection_request = composio.connected_accounts.initiate(
12         user_id=user_id,
13         auth_config_id=auth_config_id,
14     )
15 
16     print(
17         f"Visit this URL to authenticate Zoho bigin: {connection_request.redirect_url}"
18     )
19 
20     # This will wait for the auth flow to be completed
21     connection_request.wait_for_connection(timeout=15)
22     return connection_request.id
23 
24 
25 connection_id = authenticate_toolkit(user_id, zoho_bigin_auth_config_id)
26 
27 # You can also verify the connection status using:
28 connected_account = composio.connected_accounts.get(connection_id)
29 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Zoho bigin toolkit’s playground](https://app.composio.dev/app/Zoho bigin)

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["ZOHO_BIGIN"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

ZOHO_BIGIN_ADD_RECORDS

Tool Name: Add Records

Description

Tool to add new records to a module. use when you need to programmatically insert one or more records into bigin after confirming module name and field api names. provide required fields per module (e.g., contacts requires last name).

Action Parameters

data

arrayRequired

module_api_name

stringRequired

trigger

array

Action Response

data

arrayRequired

error

string

successful

booleanRequired

ZOHO_BIGIN_ADD_TAGS_TO_RECORDS

Tool Name: Add Tags to Records

Description

Tool to add tags to a specific record in a module. use when you need to categorize or label a record after creation or update.

Action Parameters

module_api_name

stringRequired

over_write

boolean

record_id

stringRequired

ZOHO_BIGIN_CREATE_TAGS

Tool Name: Create Tags

Description

Tool to create tags for a module. use when you need to add new tags to a specific module in zoho bigin.

Action Parameters

module

stringRequired

ZOHO_BIGIN_DELETE_ATTACHMENT

Tool Name: Delete Attachment

Description

Tool to delete an attachment from a record. use when you need to remove a file after confirming its record id and attachment id.

Action Parameters

attachment_id

stringRequired

module_api_name

stringRequired

record_id

stringRequired

Action Response

data

arrayRequired

error

string

successful

booleanRequired

ZOHO_BIGIN_DELETE_RECORDS

Tool Name: Delete Records

Description

Tool to delete records from a module. use when removing one or multiple records after confirming their ids.

Action Parameters

ids

arrayRequired

module_api_name

stringRequired

wf_trigger

booleanDefaults to True

Action Response

data

arrayRequired

error

string

successful

booleanRequired

ZOHO_BIGIN_DOWNLOAD_ATTACHMENT

Tool Name: Download Attachment

Description

Tool to download an attachment from a record. use when you need the binary content of a specific attachment after confirming the record and attachment ids.

Action Parameters

attachment_id

stringRequired

module_api_name

stringRequired

record_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZOHO_BIGIN_GET_ATTACHMENTS

Tool Name: Get Attachments

Description

Tool to retrieve attachments for a record. use when you need a paginated list of attachments for a given module record.

Action Parameters

fields

stringRequired

module_api_name

stringRequired

page

integer

per_page

integer

record_id

stringRequired

Action Response

data

arrayRequired

error

string

info

objectRequired

successful

booleanRequired

ZOHO_BIGIN_GET_DELETED_RECORDS

Tool Name: Get Deleted Records

Description

Tool to get a list of deleted records in a module. use when auditing or restoring recently deleted data (recycle within 60 days, permanent within 120 days).

Action Parameters

module_api_name

stringRequired

page

integerDefaults to 1

per_page

integerDefaults to 200

type

stringDefaults to all

Action Response

data

arrayRequired

error

string

info

objectRequired

successful

booleanRequired

ZOHO_BIGIN_GET_MODULES

Tool Name: Get Modules

Description

Tool to retrieve a list of all modules. use when you need to discover which modules are available in bigin.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

ZOHO_BIGIN_GET_RECORDS

Tool Name: Get Records

Description

Tool to retrieve records from a bigin module. use when listing or querying module data with specific fields, sorting, filtering, and pagination.

Action Parameters

approved

string

cvid

string

fields

stringRequired

module_api_name

stringRequired

page

integerDefaults to 1

page_token

string

per_page

integerDefaults to 200

sort_by

string

sort_order

string

Action Response

data

arrayRequired

error

string

info

objectRequired

successful

booleanRequired

ZOHO_BIGIN_UPDATE_RECORDS

Tool Name: Update Records

Description

Tool to update existing records in a module. use when you need to modify one or multiple records after confirming their ids and field api names. supports up to 100 records per call; specify an optional trigger to control workflow execution.

Action Parameters

data

arrayRequired

module_api_name

stringRequired

record_id

string

trigger

array

Action Response

data

arrayRequired

error

string

successful

booleanRequired

ZOHO_BIGIN_UPLOAD_ATTACHMENT

Tool Name: Upload Attachment

Description

Tool to upload an attachment to a record. use when you need to attach a file or specify a public url for upload to a bigin record. ensure module api name and record id are correct before calling.

Action Parameters

attachment_url

string

file

string

module_api_name

stringRequired

record_id

stringRequired

Action Response

data

arrayRequired

error

string

successful

booleanRequired