> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackone.com/llms.txt > Use this file to discover all available pages before exploring further. # Zoho Bigin > How to set up the Zoho Bigin connector, plus the actions and events that are available. ![Zoho Bigin](https://stackone-logos.com/api/zohobigin/filled/svg) Previewv0.2.1[See changelog](https://docs.stackone.com/connectors/zohobigin/changelog.md) [75 actions](#actions) · [21 events](#events) · 2 auth methods CRM IAM ## Getting Started **1. Create or Select a Project** Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md). **2. Configure the Connector** Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile). > [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/zohobigin/guides/connector-profile/oauth-2-0.md) > > Each person connecting signs in to Zoho. One server-based client in the Zoho API Console serves every Bigin organization... > [card] [Self Client · Connector Profile](https://docs.stackone.com/connectors/zohobigin/guides/connector-profile/self-client.md) > > No sign-in when connecting. A Self Client created in the Zoho API Console connects only the Bigin organization it was cr... Optionally, configure receiving Events for Zoho Bigin into StackOne. > [card] [Webhooks setup](https://docs.stackone.com/connectors/zohobigin/guides/webhook-setup.md) **3. Link an Account** Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)). See the guide for the authentication type chosen in the Connector Profile: > [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/zohobigin/guides/link-account/oauth-2-0.md) > [card] [Self Client · Link Account](https://docs.stackone.com/connectors/zohobigin/guides/link-account/self-client.md) **4. Use Actions** Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md). Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md). ## Actions Scopes Select all | Clear ZohoBigin.bulk.ALL ZohoBigin.change\_owner.CREATE ZohoBigin.coql.READ ZohoBigin.files.CREATE ZohoBigin.files.READ ZohoBigin.modules.ALL ZohoBigin.modules.attachments.ALL ZohoBigin.modules.attachments.READ ZohoBigin.modules.notes.ALL ZohoBigin.modules.notes.READ ZohoBigin.notifications.ALL ZohoBigin.org.CREATE ZohoBigin.org.READ ZohoBigin.send\_mail.all.CREATE ZohoBigin.settings.custom\_views.READ ZohoBigin.settings.emails.READ ZohoBigin.settings.fields.READ ZohoBigin.settings.layouts.READ ZohoBigin.settings.modules.READ ZohoBigin.settings.profiles.READ ZohoBigin.settings.related\_lists.READ ZohoBigin.settings.roles.READ ZohoBigin.settings.tags.ALL ZohoBigin.settings.tags.READ ZohoBigin.users.ALL ZohoBigin.users.READ ZohoFiles.files.ALL No scopes found 75 actions ActionDescriptionRequired scopes Get Attachments`zohobigin_get_attachments` List the files attached to a Bigin record. `ZohoBigin.modules.attachments.READ` Upload Attachment`zohobigin_upload_attachment` Attach a file or a link to a Bigin record, such as a contract on a deal or a document on a contact. `ZohoBigin.modules.attachments.ALL` Download Attachment`zohobigin_download_attachment` Download a file attached to a Bigin record. `ZohoBigin.modules.attachments.READ` Delete Attachment`zohobigin_delete_attachment` Delete a file attached to a Bigin record. `ZohoBigin.modules.attachments.ALL` Create Bulk Read Job`zohobigin_create_bulk_read_job` Start a background job that exports Bigin records to a CSV file. `ZohoBigin.bulk.ALL` Get Bulk Read Job Details`zohobigin_get_bulk_read_job_details` Check the status of a Bigin bulk read job. `ZohoBigin.bulk.ALL` Download Bulk Read Result`zohobigin_download_bulk_read_result` Download the exported records of a completed Bigin bulk read job. `ZohoBigin.bulk.ALL` Upload Bulk Write File`zohobigin_upload_bulk_write_file` Upload a zipped CSV file to use in a Bigin bulk write job. `ZohoFiles.files.ALL` Create Bulk Write Job`zohobigin_create_bulk_write_job` Start a background job that inserts, updates or upserts Bigin records from an uploaded file. `ZohoBigin.bulk.ALL` Get Bulk Write Job Details`zohobigin_get_bulk_write_job_details` Check the status of a Bigin bulk write job. `ZohoBigin.bulk.ALL` Download Bulk Write Result`zohobigin_download_bulk_write_result` Download the per-row result file of a completed Bigin bulk write job. `ZohoBigin.bulk.ALL` Get From Addresses`zohobigin_get_from_addresses` List the email addresses the connected Bigin user may send email from. `ZohoBigin.settings.emails.READ` Send Mail`zohobigin_send_mail` Send an email from Bigin to a contact, company or deal, logged on that record. `ZohoBigin.send_mail.all.CREATE` Upload Files`zohobigin_upload_files` Upload a file to Bigin storage to use in a file upload or image field. `ZohoBigin.files.CREATE` Get Files`zohobigin_get_files` Download a file stored in Bigin by its encrypted ID. `ZohoBigin.files.READ` Get Unified Credentials`zohobigin_unified_get_me` Get the identity of the current Zoho Bigin connection. `ZohoBigin.users.READ``ZohoBigin.org.READ` List Unified Roles`zohobigin_unified_list_roles` List unified roles and permission profiles in Zoho Bigin. `ZohoBigin.settings.roles.READ``ZohoBigin.settings.profiles.READ` Get Unified Role`zohobigin_unified_get_role` Get a unified Zoho Bigin role or permission profile by id. `ZohoBigin.settings.roles.READ``ZohoBigin.settings.profiles.READ` List Unified Users`zohobigin_unified_list_users` List unified users in Zoho Bigin. `ZohoBigin.users.READ``ZohoBigin.org.READ` Get Unified User`zohobigin_unified_get_user` Get a unified Zoho Bigin user by id. `ZohoBigin.users.READ``ZohoBigin.org.READ` Upload Profile Photo`zohobigin_upload_profile_photo` Set the profile image of a Bigin contact, company or product. `ZohoBigin.modules.ALL` Download Profile Photo`zohobigin_download_profile_photo` Download the profile image of a Bigin contact, company or product. `ZohoBigin.modules.ALL` Delete Profile Photo`zohobigin_delete_profile_photo` Remove the profile image of a Bigin contact, company or product. `ZohoBigin.modules.ALL` Get Modules`zohobigin_get_modules` List the modules of the Bigin organization with their API names. `ZohoBigin.settings.modules.READ` Get Module`zohobigin_get_module` Get the metadata of one Bigin module, such as its labels, permissions and related lists. `ZohoBigin.settings.modules.READ` Get Fields`zohobigin_get_fields` List the fields of a Bigin module with their API names, types and picklist values. `ZohoBigin.settings.fields.READ` Get Layouts`zohobigin_get_layouts` List the layouts of a Bigin module. For Pipelines, each layout is a team pipeline with its sub-pipelines and stages. `ZohoBigin.settings.layouts.READ` Get Related Lists`zohobigin_get_related_lists` List the related lists of a Bigin module, such as Contacts or Products on a company. `ZohoBigin.settings.related_lists.READ` Get Custom Views`zohobigin_get_custom_views` List the custom views (saved filters) of a Bigin module. `ZohoBigin.settings.custom_views.READ` Get Custom View`zohobigin_get_custom_view` Get one custom view of a Bigin module with its criteria and fields. `ZohoBigin.settings.custom_views.READ` Get Notes`zohobigin_get_notes` List the notes across all records in Bigin. `ZohoBigin.modules.notes.READ` Get Record Notes`zohobigin_get_record_notes` List the notes of one Bigin record. `ZohoBigin.modules.notes.READ` Add Notes`zohobigin_add_notes` Add notes to Bigin records, such as a call summary on a contact or deal. `ZohoBigin.modules.notes.ALL` Update Notes`zohobigin_update_notes` Change the title or text of a note on a Bigin record. `ZohoBigin.modules.notes.ALL` Delete Notes`zohobigin_delete_notes` Delete Bigin notes by ID. `ZohoBigin.modules.notes.ALL` Enable Notifications`zohobigin_enable_notifications` Subscribe a URL to create, edit or delete events of Bigin modules. `ZohoBigin.notifications.ALL` Get Notification Details`zohobigin_get_notification_details` List the Bigin notification channels and their events. `ZohoBigin.notifications.ALL` Update Notification Details`zohobigin_update_notification_details` Replace the settings of Bigin notification channels. `ZohoBigin.notifications.ALL` Update Notification Info`zohobigin_update_notification_info` Change some settings of Bigin notification channels and keep the rest. `ZohoBigin.notifications.ALL` Disable Notifications`zohobigin_disable_notifications` Stop Bigin notification channels. `ZohoBigin.notifications.ALL` Get Organization`zohobigin_get_org` Get the Zoho Bigin organization this connection is bound to. `ZohoBigin.org.READ` Upload Organization Image`zohobigin_upload_org_image` Set the logo of the Zoho Bigin organization. `ZohoBigin.org.CREATE` Get Team Pipeline Records`zohobigin_get_team_pipeline_records` List the deals (pipeline records) of one Bigin team pipeline. `ZohoBigin.modules.ALL` Get Team Pipeline Records Related To Contact`zohobigin_get_team_pipeline_records_related_to_contact` List the deals of one Bigin team pipeline that a contact is part of. `ZohoBigin.modules.ALL` Get Profiles`zohobigin_get_profiles` List the permission profiles of a Zoho Bigin organization. `ZohoBigin.settings.profiles.READ` Get Records`zohobigin_get_records` List the records of a Bigin module, such as contacts, companies, products or activities. `ZohoBigin.modules.ALL` Get Record`zohobigin_get_record` Get one record of a Bigin module by its ID, with all its fields. `ZohoBigin.modules.ALL` Add Records`zohobigin_add_records` Create up to 100 records in a Bigin module, such as contacts, companies, deals, products or activities. `ZohoBigin.modules.ALL` Update Records`zohobigin_update_records` Update up to 100 existing records of a Bigin module. `ZohoBigin.modules.ALL` Upsert Records`zohobigin_upsert_records` Insert records, or update them when a matching record already exists in the Bigin module. `ZohoBigin.modules.ALL` Delete Records`zohobigin_delete_records` Delete up to 100 records of a Bigin module. Deleted records go to the recycle bin. `ZohoBigin.modules.ALL` Search Records`zohobigin_search_records` Search the records of a Bigin module by criteria, email, phone or word. `ZohoBigin.modules.ALL` Get Deleted Records`zohobigin_get_deleted_records` List records deleted from a Bigin module, in the recycle bin or permanently deleted. `ZohoBigin.modules.ALL` Get Records Count`zohobigin_get_records_count` Count the records of a Bigin module. `ZohoBigin.modules.ALL` Get Records (COQL)`zohobigin_get_records_coql` Query Bigin records with a SQL-like COQL SELECT statement. `ZohoBigin.coql.READ` Change Record Owner`zohobigin_change_record_owner` Assign up to 500 records of a Bigin module to another user. `ZohoBigin.change_owner.CREATE` Get Related Records`zohobigin_get_related_records` List the records in a related list of a Bigin record, such as the contacts of a company or the products of a deal. `ZohoBigin.modules.ALL` Update Related Records`zohobigin_update_related_records` Link records to a Bigin record through a related list, such as adding products to a deal or contacts to a deal. `ZohoBigin.modules.ALL` Delink Related Records`zohobigin_delink_related_records` Unlink records from a Bigin record related list. The records themselves are kept. `ZohoBigin.modules.ALL` Get Roles`zohobigin_get_roles` List the hierarchy roles of a Zoho Bigin organization. `ZohoBigin.settings.roles.READ` Get Tag List`zohobigin_get_tag_list` List the tags of a Bigin module. `ZohoBigin.settings.tags.READ` Add Tags`zohobigin_add_tags` Create tags in a Bigin module. `ZohoBigin.settings.tags.ALL` Update Tags`zohobigin_update_tags` Rename tags of a Bigin module. `ZohoBigin.settings.tags.ALL` Delete Tags`zohobigin_delete_tags` Delete a tag from Bigin. Records keep their data but lose the tag. `ZohoBigin.settings.tags.ALL` Add Tags To Records`zohobigin_add_tags_records` Add tags to records of a Bigin module. `ZohoBigin.modules.ALL` Remove Tags From Records`zohobigin_remove_tags` Remove tags from records of a Bigin module. `ZohoBigin.modules.ALL` Get Record Count For Tag`zohobigin_get_record_count_specific_tag` Count the records of a Bigin module that carry a tag. `ZohoBigin.settings.tags.READ` Get Users`zohobigin_get_users` List the users of a Zoho Bigin organization with their role and profile. `ZohoBigin.users.READ` Get User`zohobigin_get_user` Get one Zoho Bigin user by id with their role and profile. `ZohoBigin.users.READ` Get Current User`zohobigin_get_current_user` Get the Zoho Bigin user this connection signs in as. `ZohoBigin.users.READ` Check User Access`zohobigin_check_user_access` Read one user, the organization and the admin list from Zoho Bigin to prove the connection can serve the roster and expa... `ZohoBigin.users.READ``ZohoBigin.org.READ` Add User`zohobigin_add_user` Invite a new user to the Bigin organization. `ZohoBigin.users.ALL` Update Users`zohobigin_update_users` Update details of several Bigin users in one call. `ZohoBigin.users.ALL` Update Specific User`zohobigin_update_specific_user` Update the details of one Bigin user. `ZohoBigin.users.ALL` Delete User`zohobigin_delete_user` Delete a user from the Bigin organization. `ZohoBigin.users.ALL` ## Events Tags Select all | Clear Activities Records No tags found 21 events EventDescriptionTags Task Created`zohobigin_webhook_task_created` Fired when a task is created in Bigin. Activities Task Updated`zohobigin_webhook_task_updated` Fired when a task is updated in Bigin. Activities Task Deleted`zohobigin_webhook_task_deleted` Fired when a task is deleted in Bigin. Activities Event Created`zohobigin_webhook_event_created` Fired when an event (meeting) is created in Bigin. Activities Event Updated`zohobigin_webhook_event_updated` Fired when an event (meeting) is updated in Bigin. Activities Event Deleted`zohobigin_webhook_event_deleted` Fired when an event (meeting) is deleted in Bigin. Activities Call Created`zohobigin_webhook_call_created` Fired when a call is created in Bigin. Activities Call Updated`zohobigin_webhook_call_updated` Fired when a call is updated in Bigin. Activities Call Deleted`zohobigin_webhook_call_deleted` Fired when a call is deleted in Bigin. Activities Contact Created`zohobigin_webhook_contact_created` Fired when a contact is created in Bigin. Records Contact Updated`zohobigin_webhook_contact_updated` Fired when a contact is updated in Bigin. Records Contact Deleted`zohobigin_webhook_contact_deleted` Fired when a contact is deleted in Bigin. Records Pipeline Created`zohobigin_webhook_pipeline_created` Fired when a pipeline record (deal) is created in Bigin. Records Pipeline Updated`zohobigin_webhook_pipeline_updated` Fired when a pipeline record (deal) is updated in Bigin. Records Pipeline Deleted`zohobigin_webhook_pipeline_deleted` Fired when a pipeline record (deal) is deleted in Bigin. Records Company Created`zohobigin_webhook_company_created` Fired when a company is created in Bigin. Records Company Updated`zohobigin_webhook_company_updated` Fired when a company is updated in Bigin. Records Company Deleted`zohobigin_webhook_company_deleted` Fired when a company is deleted in Bigin. Records Product Created`zohobigin_webhook_product_created` Fired when a product is created in Bigin. Records Product Updated`zohobigin_webhook_product_updated` Fired when a product is updated in Bigin. Records Product Deleted`zohobigin_webhook_product_deleted` Fired when a product is deleted in Bigin. Records This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.