Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Bigin by Zoho CRM

Scalekit connector
Open markdown

The Bigin by Zoho CRM connector lets your AI agent act in each user's Bigin by Zoho CRM account. Each user signs in to Bigin by Zoho CRM once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 21 tools.

Tools
21
What they doRead · write · destructive
12 · 7 · 212 read7 write2 destructive
Users sign in with
OAuth app
Your own Bigin by Zoho CRM app

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Bigin by Zoho CRM connection

    In AgentKit > Connections, create a Bigin by Zoho CRM connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    Bigin by Zoho CRM connections use your own OAuth app. Register one with Bigin by Zoho CRM and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the Bigin by Zoho CRM connection.

  5. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'zohobigin'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Bigin by Zoho CRM:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'zohobigin_modules_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • zohobigin_custom_views_listList the custom views (saved filters) of a module.Read-only

    List Custom Views

    List the custom views (saved filters) of a module. Returns custom_views[] with id, name, display_value and default flag. Use zohobigin_custom_views_list to get a cvid for zohobigin_records_list.

    Inputs

    modulestringrequired
    API name of the module that holds the views: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of ContactsPipelinesAccountsProductsTasksEventsCalls
  • zohobigin_fields_listList the fields of a module.Read-only

    List Fields

    List the fields of a module. Returns fields[] with api_name, field_label, data_type, length, required/read-only flags and picklist values. Use zohobigin_fields_list to get field API names for fields, criteria and record data.

    Inputs

    modulestringrequired
    API name of the module that holds the fields: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of ContactsPipelinesAccountsProductsTasksEventsCalls
  • zohobigin_modules_listList the modules in the Bigin organization.Read-only

    List Modules

    List the modules in the Bigin organization. Returns modules[] with api_name, module_name, singular and plural labels, and whether each module is API-supported. Use zohobigin_modules_list to find module API names. Use zohobigin_fields_list for a module's fields.

    Inputs

    This tool takes no inputs.

  • zohobigin_notes_listList the notes on a record.Read-only

    List Notes

    List the notes on a record. Returns data[] of notes with id, Note_Title, Note_Content, Parent_Id and owner, plus paging info. Use zohobigin_notes_list to read a record's notes. Use zohobigin_note_create to add one.

    Inputs

    fieldsstringrequired
    Comma-separated note fields to return. Example: Note_Title,Note_Content,Parent_Id
    modulestringrequired
    API name of the module that holds the records: Contacts, Pipelines, Accounts, Products. Companies use Accounts; deals use Pipelines. Example: Contactsone of ContactsPipelinesAccountsProducts
    record_idstringrequired
    ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
    pageinteger
    Page index, starting at 1. Example: 2
    per_pageinteger
    Records per page, up to 200 (the default). Example: 50
  • zohobigin_org_getGet the Bigin organization's details.Read-only

    Get Organization

    Get the Bigin organization's details. Returns org[] with id, company_name, primary_email, currency, time_zone, country and license details. Use zohobigin_org_get to check which organization the connection is for.

    Inputs

    This tool takes no inputs.

  • zohobigin_record_getGet one record from a Bigin module with all of its fields.Read-only

    Get Record

    Get one record from a Bigin module with all of its fields. Returns data[] with the single record: id, Owner, the module's fields, tags and timestamps. Use zohobigin_record_get when you know the record ID. Use zohobigin_records_list or zohobigin_records_search to find it.

    Inputs

    modulestringrequired
    API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of ContactsPipelinesAccountsProductsTasksEventsCalls
    record_idstringrequired
    ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
  • zohobigin_records_listList records in a Bigin module (contacts, pipeline deals, companies, products, tasks, events or calls), with chosen fields, sorting, custom view and paging.Read-only

    List Records

    List records in a Bigin module (contacts, pipeline deals, companies, products, tasks, events or calls), with chosen fields, sorting, custom view and paging. Returns data[] of records with id and the requested fields, plus info with page, per_page, count, more_records and next_page_token. Use zohobigin_records_list to browse a module. Use zohobigin_records_search to filter by criteria, email, phone or a word.

    Inputs

    fieldsstringrequired
    Comma-separated field API names to return, up to 50 (see zohobigin_fields_list). Example: Last_Name,Email,Phone
    modulestringrequired
    API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of ContactsPipelinesAccountsProductsTasksEventsCalls
    approvedstring
    Approval state: true (default), false or both. Example: bothone of truefalseboth
    cvidstring
    Custom view ID to list records from (see zohobigin_custom_views_list). Example: 2034020000000087501
    pageinteger
    Page index, starting at 1. Example: 2
    page_tokenstring
    next_page_token from a previous response, to read past the first 2000 records. Example: cd2cb80b7af0973c8e00
    per_pageinteger
    Records per page, up to 200 (the default). Example: 50
    sort_bystring
    Field API name to sort by. Example: Modified_Time
    sort_orderstring
    asc or desc. Example: descone of ascdesc