AC

πŸš€ Feature: Bigin by Zoho CRM Integration

This PR implements a comprehensive integration piece for Bigin by Zoho CRM, addressing the feature request in issue #8601.

πŸ“‹ What’s Implemented

πŸ” Authentication

  • OAuth2 Authentication with support for all Zoho regional domains:
    • United States (.com)
    • Europe (.eu)
    • India (.in)
    • Australia (.com.au)
    • Japan (.jp)
    • China (.com.cn)
    • Saudi Arabia (.sa)
    • Canada (.ca)
  • Proper scope configuration for Bigin API access
  • Authentication validation with error handling

πŸ” Search Actions (5 total)

  • Search Contact - Find contacts by email, name, phone, or mobile
  • Search Company - Find companies by name, phone, or website
  • Search Product - Find products by name or product code
  • Search Pipeline Record - Find deals by name, stage, or amount
  • Search User - Find users by email address

✏️ Write Actions (14 total)

Contact Management:

  • Create Contact - Full contact creation with all standard fields
  • Update Contact - Update existing contact records

Company Management:

  • Create Company - Company creation with billing address support
  • Update Company - Update existing company records

Pipeline Records (Deals):

  • Create Pipeline Record - Deal creation with amount, stage, closing date
  • Update Pipeline Record - Update existing deals

Task Management:

  • Create Task - Task creation with due dates, priority, status
  • Update Task - Update existing tasks

Event Management:

  • Create Event - Calendar event creation with start/end times, venues
  • Update Event - Update existing events

Call Logging:

  • Create Call - Call record creation with duration, type, status

πŸ”” Webhook Triggers (4 total)

  • New Contact - Triggers when a contact is created
  • Updated Contact - Triggers when a contact is modified
  • New Company - Triggers when a company is created
  • New Pipeline Record - Triggers when a deal is created

πŸ› οΈ Additional Features

  • Custom API Call Action - Allows arbitrary API calls to any Bigin endpoint
  • Comprehensive Error Handling - Proper error messages for authentication, rate limits, API errors
  • Field Validation - Required field validation and data cleanup
  • Multi-Domain Support - Dynamic API URL resolution based on selected domain

🎯 Addresses Issue Requirements

This implementation fully addresses the requirements outlined in issue #8601:

  • βœ… Complete Bigin by Zoho CRM integration
  • βœ… OAuth2 authentication with multi-domain support
  • βœ… CRUD operations for all major CRM entities
  • βœ… Search functionality across key data types
  • βœ… Webhook triggers for real-time data synchronization
  • βœ… Follows Activepieces coding standards and patterns

πŸ“ Files Added

packages/pieces/community/bigin-by-zoho/
β”œβ”€β”€ package.json
β”œβ”€β”€ project.json
β”œβ”€β”€ tsconfig.json
β”œβ”€β”€ tsconfig.lib.json
β”œβ”€β”€ README.md
└── src/
    β”œβ”€β”€ index.ts
    └── lib/
        β”œβ”€β”€ common/
        β”‚   β”œβ”€β”€ auth.ts          # OAuth2 authentication configuration
        β”‚   β”œβ”€β”€ client.ts        # API client with error handling
        β”‚   └── utils.ts         # Utility functions and field mappings
        β”œβ”€β”€ actions/
        β”‚   β”œβ”€β”€ search-*.ts      # 5 search actions
        β”‚   β”œβ”€β”€ create-*.ts      # 7 create actions
        β”‚   └── update-*.ts      # 7 update actions
        └── triggers/
            β”œβ”€β”€ new-contact.ts
            β”œβ”€β”€ updated-contact.ts
            β”œβ”€β”€ new-company.ts
            └── new-pipeline-record.ts

πŸ§ͺ Testing Instructions

Prerequisites

  1. Bigin by Zoho Account - Create a free account at bigin.zoho.com
  2. Zoho Developer Console - Set up OAuth2 app at api-console.zoho.com
  3. OAuth2 Credentials - Configure client ID, client secret, and redirect URLs

Authentication Testing

  1. Configure OAuth2 credentials in Activepieces
  2. Select appropriate domain based on account location
  3. Complete OAuth2 flow and verify token acquisition
  4. Test authentication validation with invalid credentials

Action Testing

Search Actions:

  1. Test each search action with valid criteria
  2. Verify search operators (equals, contains, starts_with, ends_with)
  3. Test with non-existent records to verify empty results

Write Actions:

  1. Test contact creation with required and optional fields
  2. Test company creation with billing address
  3. Test pipeline record creation with amount and dates
  4. Test task creation with due dates and priorities
  5. Test event creation with start/end times
  6. Test call logging with duration and status
  7. Verify update operations modify existing records correctly

Triggers:

  1. Set up webhook triggers in test flows
  2. Create/update records in Bigin to verify trigger firing
  3. Verify payload structure matches expected format

Error Handling Testing

  1. Test with invalid authentication tokens
  2. Test with malformed API requests
  3. Test rate limiting scenarios
  4. Verify proper error messages are displayed

πŸ” Code Quality

  • βœ… TypeScript Compilation - No compilation errors
  • βœ… Code Standards - Follows Activepieces patterns and conventions
  • βœ… Error Handling - Comprehensive error handling throughout
  • βœ… Documentation - Inline comments and README documentation
  • βœ… Type Safety - Proper TypeScript types and interfaces
  • βœ… Modularity - Clean separation of concerns and reusable components

πŸ“š API Documentation

This integration is built against the official Bigin by Zoho API v2:

Closes #8601


/claim #8601

Claim

Total prize pool $150
Total paid $0
Status Pending
Submitted August 01, 2025
Last updated August 01, 2025

Contributors

VI

Vishwanath Martur

@vishwamartur

100%

Sponsors

AC

Activepieces (YC S22)

@activepieces

$150