First-party app
Bigin by Zoho CRM

Bigin by Zoho CRM

Create, read, update, search and delete Contacts, Companies, Pipelines and Tasks in Bigin by Zoho CRM.

stable Customer Relationship Management

About

Bigin by Zoho CRM ships in the w6w first-party pack. It declares 23 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.

App id
io.w6w.bigin
Version
0.1.0
Author
w6w
Licence
MIT
Categories
Customer Relationship Management

Overview

Bigin is Zoho’s lightweight pipeline CRM for small teams, and this app covers the records a pipeline is actually made of: create, read, update, delete and search Contacts, Companies (the API calls them Accounts), Pipelines (the API calls the deals Pipelines) and Tasks, plus the two user endpoints so a workflow can resolve who owns what.

Bigin hosts every account in one of eight regional data centres, each with its own API host and its own OAuth host, and the app addresses the right one per connection from the api_domain the authorization exchange returns — so an EU or Indian tenant is not silently routed through the US region. One region, Canada, breaks the naming pattern the other seven follow on the OAuth side and is implemented exactly as the vendor documents it.

Listing and reading are deliberately scoped to the four modules above: Products, Calls, Events and Notes, the approval and custom-view filters, and the bulk/upsert surfaces are left out of this first pass rather than half-implemented.

Build with Bigin by Zoho CRM

Three routes to the same 23 actions. The Workflow tab is generated from Bigin by Zoho CRM's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.

Create Company

company-create

Create a Company in Bigin's Accounts module. `Account_Name` is mandatory. A Company lives in Bigin's `Accounts` module, which is why this action posts to `/Accounts`.

Delete Company

company-delete

Delete a Company from Bigin's Accounts module. Bigin moves the record to its Recycle Bin.

Get Company

company-get

Retrieve one Company record by id from Bigin's Accounts module.

List Companies

company-list

List records in Bigin's Accounts module. `fields` is required by the API (max 50 names).

Update Company

company-update

Update a Company's fields in Bigin's Accounts module.

Create Contact

contact-create

Create a Contact in Bigin's Contacts module. `Last_Name` is Bigin's system-mandatory field, e.g. { "Last_Name": "Smith", "Email": "a@acme.com" }.

Delete Contact

contact-delete

Delete a Contact from Bigin's Contacts module. Bigin moves the record to its Recycle Bin.

Get Contact

contact-get

Retrieve one Contact record by id from Bigin's Contacts module.

List Contacts

contact-list

List records in Bigin's Contacts module. `fields` is required by the API (max 50 names).

Update Contact

contact-update

Update a Contact's fields in Bigin's Contacts module.

Create Pipeline

pipeline-create

Create a Pipeline in Bigin's Pipelines module. `Deal_Name`, `Sub_Pipeline` and `Stage` are mandatory, e.g. { "Deal_Name": "Renewal", "Sub_Pipeline": "Sales Pipeline Standard", "Stage": "Qualification" }.

Delete Pipeline

pipeline-delete

Delete a Pipeline from Bigin's Pipelines module. Bigin moves the record to its Recycle Bin.

Get Pipeline

pipeline-get

Retrieve one Pipeline record by id from Bigin's Pipelines module.

List Pipelines

pipeline-list

List records in Bigin's Pipelines module. `fields` is required by the API (max 50 names).

Update Pipeline

pipeline-update

Update a Pipeline's fields in Bigin's Pipelines module.

Search Records

search-records

Search any module's records by criteria, email, phone or a free-text word. Exactly one of those four is required.

Create Task

task-create

Create a Task in Bigin's Tasks module. `Subject` is the only system-mandatory field, e.g. { "Subject": "Call the lead", "Due_Date": "2026-10-01" }.

Delete Task

task-delete

Delete a Task from Bigin's Tasks module. Bigin moves the record to its Recycle Bin.

Get Task

task-get

Retrieve one Task record by id from Bigin's Tasks module.

List Tasks

task-list

List records in Bigin's Tasks module. `fields` is required by the API (max 50 names).

Update Task

task-update

Update a Task's fields in Bigin's Tasks module.

Get User

user-get

Retrieve one user of the Bigin organization by id.

List Users

user-list

List the users of the Bigin organization. `type=CurrentUser` returns the profile of the user this connection is authorized as, which is how a workflow resolves the acting user's id.

A workflow step names the app and the action, and the editor fills in the connection when you pick one. This is the Step shape from the workflow spec, carrying Bigin by Zoho CRM's real ids.

{
  "manifestVersion": "2",
  "name": "bigin-example",
  "steps": [
    {
      "id": "company-create",
      "uses": {
        "app": "io.w6w.bigin",
        "action": "company-create",
        "connection": "conn_YOUR_CONNECTION_ID"
      },
      "with": {
        "fields": "<fields>"
      }
    }
  ]
}

Here are some of the things you can do

  • Create Company

    perform
    company-create
  • Get Company

    read
    company-get
  • List Companies

    read
    company-list
  • Update Company

    perform
    company-update
  • Create Contact

    perform
    contact-create

+18 more actions available

Every app-specific value here is a blank you have to fill in. An app action is reached through the connection that authenticates it, so the address is a connection id, not the app id — and connections belong to your account, so a public page cannot know yours. Create one for Bigin by Zoho CRM, then fill in the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the parameters that action declares. The call itself is real — the shape is transcribed from the studio's own snippet builder, which prints the same kind of blanks — but nothing in it is specific to Bigin by Zoho CRM. The Workflow tab is where this app's real ids are.

Install
npm install @w6w/sdk
yarn add @w6w/sdk
pnpm add @w6w/sdk
deno add npm:@w6w/sdk
Code
import { W6wClient, isActionRun } from "@w6w/sdk";

// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();

const envelope = await client.run({
  urn: "conn_YOUR_CONNECTION_ID",
  action: "company-create",
  payload: {
    fields: "<value>",
  },
});

if (isActionRun(envelope)) console.log(envelope.value);
Install the CLI
npm install -g @w6w/cli
CLI
w6w run conn_YOUR_CONNECTION_ID --action company-create --payload '{"fields":"<value>"}'

Give an AI agent Bigin by Zoho CRM — without giving it Bigin by Zoho CRM's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.

One tool call
{
  "name": "w6w_invoke",
  "arguments": {
    "ref": "app:io.w6w.bigin#company-create",
    "input": {
      "fields": "<fields>"
    }
  }
}

Every tool names its target with a single ref. The app: form above doesn't name a connection at all — the host resolves which of the caller's Bigin by Zoho CRM connections to sign with, and refuses rather than guesses when the answer is ambiguous.

What the agent gets

Credentials it can't read

The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.

A tool surface scoped to the caller

Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.

A durable workflow in one call

Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.

Health-aware discovery

Bigin by Zoho CRM's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.

The MCP surface is part of the hosted platform. Bigin by Zoho CRM itself is MIT, and the runtime that executes it is source-available (FSL).

Request MCP access

Health checks

Bigin by Zoho CRM declares its own checks, so its health is a property of the app rather than something the host guesses at.

service

Bigin platform status

Reads the "Zoho Bigin" component off Zoho's StatusIQ RSS feed (us.zohostatus.com/rss). Unauthenticated and unsigned.

quota

API credit headroom

Reads `X-API-CREDITS-REMAINING` off the cheapest authenticated call (`GET /users?type=CurrentUser`). Zoho only sends this header once usage crosses 50% of the day's credit allowance.