SMB Sales Boost Tools & Integrations

Send your leads and exports to HubSpot, Salesforce, Pipedrive, Zapier, Make, n8n, Clay, Zoho Flow or any HTTPS webhook.

Building on the API or MCP? See the API Documentation and the MCP Server.

Table of Contents

Overview | Safeguards | Supported providers | Events | Delivery format | Verifying signatures | Exported leads (batched) | Zoho Flow scripts (BETA)

Overview

SMB Sales Boost can send lead data to your CRM, automation tools, and any HTTPS endpoint: new and updated leads, finished exports, every lead of an export in batches, scheduled emails and low credit balances. This page explains what each provider does, the events you can subscribe to, what a webhook receives and how to check its signature, and how to import your exports in batches with Zoho Flow, Zapier, Make or n8n.

You can set up and manage integrations in three ways:

The REST API and the MCP server need an active paid subscription (Starter, Growth, Scale, Platinum or Enterprise); see the API introduction.

Building on the API or MCP? See the API Documentation, the Integrations API (endpoints, responses, rules, pushing one lead, creating a webhook, connecting a CRM) and the MCP Server.

Safeguards

An integration sends business contact details to an outside system automatically, on every subscribed event, until it is paused or deleted. So that nothing changes unnoticed:

Supported providers

HubSpot (hubspot)
Per-user OAuth. Creates or updates Contacts matched by email (a lead without an email creates no Contact) and Companies matched by website domain, or by exact company name when the lead has no website of its own (none, or a social or listing page such as Facebook or Yelp), and links each Contact to its Company (available when configured)
Salesforce (salesforce)
Per-user OAuth, Production or Sandbox. Creates or updates Leads matched by Email; a lead without an email creates a new Lead each time, and Company defaults to "Unknown" when the lead has no company name (available when configured)
Pipedrive (pipedrive)
Per-user OAuth; per-company API domain handled automatically. Matches Organizations by exact name and Persons by the SMB Sales Boost lead id, then by email; adds a note with the lead id on each delivery of a lead; optional Deals, see Rules worth knowing in the Integrations API (available when configured)
Zapier (zapier)
Webhook trigger URL with HMAC signature (Live)
n8n (n8n)
Webhook node with HMAC signature (Live)
Make.com (make)
Custom webhook trigger with HMAC signature (Live)
Pipedream (pipedream)
HTTP source workflow with HMAC signature (Live)
Clay (clay)
Clay table "Import data" webhook with HMAC-signed JSON rows (Live)
Generic Webhook (generic_webhook)
Any HTTPS endpoint, signed JSON payload (Live)

HubSpot, Salesforce and Pipedrive are available when they are configured for this deployment; otherwise connecting them, or using an already connected one, returns 503 provider_unavailable. GET /api/v1/integrations/providers shows the current availability of every provider.

To connect a CRM, map its fields or create Pipedrive Deals through the API, see Connect a CRM and Rules worth knowing in the Integrations API.

Events

Subscribe destinations to one or more of these events. A webhook receives each event as a signed JSON POST (see Delivery format below).

HubSpot, Salesforce and Pipedrive integrations take only lead.created and lead.updated; a subscription to any other event returns 400 validation_error. Clay integrations cannot subscribe to export.leads either (400 validation_error).

Delivery format

Each webhook delivery is an HTTPS POST with these headers:

HeaderValue
Content-Typeapplication/json
User-AgentSMB-Sales-Boost-Webhooks/1.0
X-SMB-EventThe event type, for example lead.created
X-SMB-TimestampUnix seconds when this attempt was signed
X-SMB-Signaturet=<Unix seconds>,v1=<hex> (see Verifying signatures)
X-SMB-API-KeyOnly when the webhook has a header API key set for this destination URL (see Safeguards)

The body is an envelope; data depends on the event (shortened here):

Example message (for reference, nothing to copy)

{
  "id": "evt_1760000000000_k3j9qz",
  "type": "lead.created",
  "occurredAt": "2026-10-08T12:00:00.000Z",
  "userId": "your-user-id",
  "integrationId": 42,
  "provider": "zapier",
  "data": {
    "id": 123456,
    "databaseType": "other",
    "source": "api",
    "companyName": "Acme Plumbing",
    "website": "https://acmeplumbing.example",
    "email": "[email protected]",
    "phone": "(512) 555-0100",
    "city": "Austin",
    "state": "TX",
    "lastBuyingSignal": "2026-10-01T00:00:00.000Z",
    "buyingSignalType": ["Newly Added"]
  }
}
Deliverydata
Live lead.created / lead.updated, and a leadId push (lead.created)A flat lead summary: id, databaseType, source (dashboard, api, email_schedule or crm_push; a push has crm_push), companyName, website, email, emailSecondary, emailTier1 to emailTier6, phone, phoneSecondary, phoneTotal, address, city, state, zip, country, category, description, lastBuyingSignal and buyingSignalType (a list). lastUpdated and lastUpdatedReason carry the same two values under their older names.
Push of your own data (lead.created){"lead": {...}, "source": "manual_push"} with your own object as sent (see Push one lead)
Test (lead.created){"test": true, "message": "This is a test event from SMB Sales Boost integrations", "sample": {"id": 0, "companyName": "Acme Test Co", "website": "https://example.com"}}
export.completed, email_schedule.sent, credit.low_balanceThe fields listed under Events
export.leadsOne batch of leads (see Exported leads (batched) below)

A receiver that handles pushes and tests must read three lead.created shapes: the flat lead summary (live events and leadId pushes), your own data from a push, and the test event.

Verifying signatures

X-SMB-Signature is t=<Unix seconds>,v1=<hex>. t is the same value as X-SMB-Timestamp, and v1 is the hex HMAC-SHA256 of "<t>." + rawBody, keyed with your signing secret exactly as it was returned (use the string as is; do not hex-decode it). Check it against the raw request body before you parse the JSON, compare using a timing-safe comparison after checking that the lengths match, and reject a t older than 5 minutes (every attempt is signed with a fresh t).

Use this code only if the webhook goes to your own server. It checks that a message really came from SMB Sales Boost. Zoho Flow, Zapier, Make, n8n and Pipedream users can skip it.

// Node.js (Express): verify an SMB Sales Boost webhook before using it
const crypto = require("crypto");
const express = require("express");

const app = express();
const SIGNING_SECRET = process.env.SMB_SIGNING_SECRET; // exactly as returned on create
const MAX_AGE_SECONDS = 5 * 60;

// Mount this route before app.use(express.json()), which would consume the raw body.
app.post("/smb-webhook", express.raw({ type: "application/json" }), (req, res) => {
  if (!Buffer.isBuffer(req.body)) return res.status(400).send("Expected a JSON body");

  // X-SMB-Signature: t=<Unix seconds>,v1=<hex>
  const parts = {};
  for (const item of (req.get("X-SMB-Signature") || "").split(",")) {
    const i = item.indexOf("=");
    if (i > 0) parts[item.slice(0, i).trim()] = item.slice(i + 1).trim();
  }
  const t = Number(parts.t);
  if (!Number.isInteger(t) || !parts.v1) return res.status(400).send("Missing signature");
  if (Math.abs(Date.now() / 1000 - t) > MAX_AGE_SECONDS) return res.status(400).send("Stale timestamp");

  // HMAC-SHA256 of "<t>." followed by the raw body bytes, keyed with the secret string
  const expected = crypto
    .createHmac("sha256", SIGNING_SECRET)
    .update(parts.t + ".")
    .update(req.body)
    .digest("hex");
  const a = Buffer.from(expected);
  const b = Buffer.from(parts.v1);
  if (a.length !== b.length || !crypto.timingSafeEqual(a, b)) {
    return res.status(401).send("Bad signature");
  }

  const event = JSON.parse(req.body.toString("utf8"));
  res.sendStatus(200); // answer within 8 seconds; do slow work afterwards
  console.log(event.type, event.id); // use event.id to skip duplicates
});

app.listen(3000);

Exported leads (batched)

export.leads sends every lead of each export to a webhook in batches, instead of one request per lead. Use it when the tool that receives your leads charges per run or per request, such as Zoho Flow, Zapier or Make: an export of 1,000 leads arrives as 10 messages of 100 leads. It is opt-in: switch on "Exported leads (batched)" on a webhook integration in the Integrations tab of your dashboard, or subscribe the integration to export.leads through the API or MCP.

The message

The envelope is the same as for every event: type and the X-SMB-Event header are export.leads. data holds:

Each lead says whether this export is the first time it reached your account: isNew (SMB_Is_New in the Zoho CRM format). These are the same leads that send lead.created, through any channel. Create or update records on the lead id instead of filtering on isNew: a lead with isNew: false can still be missing from your tool, for example when it first reached your account through an API search. A batch that is sent again keeps its values.

In the Standard format each lead has the fields of the flat lead summary of lead.created (see Delivery format), with source set to the export's source, plus isNew. A Standard batch (shortened):

Example: a batch in the Standard format (for reference, nothing to copy)

{
  "id": "evt_exl_3f9a1c2b7d4e5f60_1_3",
  "type": "export.leads",
  "occurredAt": "2026-10-15T12:00:00.000Z",
  "userId": "your-user-id",
  "integrationId": 42,
  "provider": "generic_webhook",
  "data": {
    "exportRef": "exp_3f9a1c2b7d4e5f60",
    "batchId": "exp_3f9a1c2b7d4e5f60:3",
    "batchNumber": 3,
    "batchCount": 3,
    "batchSize": 100,
    "leadCount": 49,
    "totalLeads": 250,
    "blacklistedCount": 0,
    "source": "api",
    "databaseType": "other",
    "exportId": 412,
    "exportedAt": "2026-10-15T12:00:00.000Z",
    "format": "standard",
    "skipped": [{"id": 123460, "reason": "removed"}],
    "leads": [
      {
        "id": 123456,
        "databaseType": "other",
        "source": "api",
        "companyName": "Acme Plumbing",
        "website": "https://acmeplumbing.example",
        "email": "[email protected]",
        "phone": "(512) 555-0100",
        "city": "Austin",
        "state": "TX",
        "lastBuyingSignal": "2026-10-01T00:00:00.000Z",
        "buyingSignalType": ["Newly Added"],
        "isNew": true
      }
    ]
  }
}

Bigin by Zoho CRM (BETA): Bigin has no Leads module, so each lead is {"smbLeadId", "isNew", "company", "contact"}. company uses the field names of Bigin Companies (module Accounts); its Account_Name is the company name, or the website's host name when there is none. contact uses the field names of Bigin Contacts and is null when the lead has no valid email, or when an earlier lead of the same batch has the same email. Its Last_Name is the company name, because Bigin requires a last name and our leads are businesses. The contact has no link to its company: the Bigin script below adds it after saving the company. The company's Description holds the lead's description, category and last buying signal, each on its own line, and the contact's lists the lead's other emails. Values are shortened to Bigin's field lengths, for example 100 characters for a company name and 30 for a city, and fields without a value are left out of company and contact. Emails are cleaned before they are checked: a mailto: prefix and angle brackets are removed, and a value that holds several addresses, separated by commas, semicolons, vertical bars or spaces, is split into single addresses. An address that is still not a plain, valid email is left out, never shortened. One lead (shortened):

Example: one lead in the Bigin by Zoho CRM format (for reference, nothing to copy)

{
  "smbLeadId": "123456",
  "isNew": true,
  "company": {
    "Account_Name": "Acme Plumbing",
    "Website": "https://acmeplumbing.example",
    "Phone": "(512) 555-0100",
    "Billing_Street": "1 Main St",
    "Billing_City": "Austin",
    "Billing_State": "TX",
    "Billing_Code": "78701",
    "Billing_Country": "US",
    "Description": "Family plumbing business."
  },
  "contact": {
    "Last_Name": "Acme Plumbing",
    "Email": "[email protected]",
    "Phone": "(512) 555-0100",
    "Mailing_Street": "1 Main St",
    "Mailing_City": "Austin",
    "Mailing_State": "TX",
    "Mailing_Zip": "78701",
    "Mailing_Country": "US",
    "Description": "Other emails: [email protected]"
  }
}

Zoho CRM (BETA): each lead is one record of the Zoho CRM Leads module. Company and Last_Name, which Zoho CRM requires, both carry the company name, or the website's host name when there is none. Email and Secondary_Email are the lead's first two valid emails, cleaned and checked as in the Bigin format; an invalid email is left out, never shortened. Each email is sent only once per batch: a later lead with an email that an earlier lead of the same batch already has is sent without that email. The lead's description, category and last buying signal are in Description, and fields without a value are left out. SMB_Lead_ID (our lead id, as text) and SMB_Is_New are meant for two custom fields that you add to Leads (see the Zoho CRM script below). One lead:

Example: one lead in the Zoho CRM format (for reference, nothing to copy)

{
  "SMB_Lead_ID": "123456",
  "Company": "Acme Plumbing",
  "Last_Name": "Acme Plumbing",
  "Email": "[email protected]",
  "Secondary_Email": "[email protected]",
  "Phone": "(512) 555-0100",
  "Website": "https://acmeplumbing.example",
  "Street": "1 Main St",
  "City": "Austin",
  "State": "TX",
  "Zip_Code": "78701",
  "Country": "US",
  "Description": "Family plumbing business.",
  "SMB_Is_New": true
}

Receiving batches

When a batch fails

Retry

Recipes

Send a sample batch

The Send sample batch button on the Exported leads (batched) card of an integration's Events tab, POST /api/v1/integrations/:id/test with {"eventType": "export.leads"}, or MCP test_integration with eventType export.leads sends one sample batch to the active export.leads subscription, using its saved URL and format (save the integration first). data starts with "test": true and has its own exportRef (exp_test_ and 8 hex characters), batch 1 of 1, two made-up leads (Acme Test Co with every field filled in, Beta Test Co with only a few) and one example skipped entry, in the subscription's format. It is sent in one attempt, must be answered within 15 seconds, uses no credits and is recorded in the deliveries. Asking for the sample batch when the integration has no active export.leads subscription answers 400 "Exported leads (batched) is not switched on for this integration. Switch it on and save, then send the sample batch." Without eventType, the test also sends the sample batch when export.leads is the integration's only active event.

Zoho Flow scripts (BETA)

Which script do I use?

Not sure which one you have? Bigin's web address starts with bigin.zoho, Zoho CRM's with crm.zoho.

These two Zoho Flow custom functions (Deluge) are a starting point, written from Zoho's documentation and not yet tested against a live Zoho account, so try them with a few leads first. Each script ignores messages that are not export.leads, skips sample batches unless you set sendSampleBatches to true, sends the records as they arrive in one call to Zoho (the Bigin script makes one call for the companies and one for the contacts), checks the result of each record (Zoho reports a refused record inside an answer that otherwise looks successful) and returns a summary that you can read in the flow's History. Because the Bigin by Zoho CRM and Zoho CRM formats leave out empty fields, an update never clears a field you filled in. A batch of 100 leads takes about 2,500 Deluge statements with the Bigin script and about 750 with the Zoho CRM script, below Zoho's limit of 5,000 per function. Before you use one, set apiDomain to your Zoho data center (https://www.zohoapis.com in the US, or the same address ending in .eu, .in, .com.au, .jp, .ca, .com.cn or .sa) and put the link name of your Zoho Flow connection in each invokeurl block. If Zoho Flow reports that the function ran too long, lower Leads per batch.

Script for Zoho CRM

Use this script only if you use Zoho CRM (its Leads module) and the integration's Format is Zoho CRM. For Bigin, use the Script for Bigin by Zoho CRM below.

Setup: first add two custom fields to the Leads module: "SMB Lead ID" (single line, with "Do not allow duplicate values" ticked) and "SMB Is New" (checkbox). The script then matches leads by SMB_Lead_ID only, so every business stays its own Lead, even when several businesses share one email; a Lead you added to Zoho CRM in another way is not matched. Without the custom fields, set useCustomFields to false: leads are then matched by Email only, so businesses that share an email become one Lead, which the last one exported overwrites, and a lead without an email is added again each time it is exported.

// SMB Sales Boost: "Exported leads (batched)" to Zoho CRM Leads
// Zoho Flow custom function (Deluge). BETA: written from Zoho's documentation,
// not yet tested against a live Zoho account.
//
// What it does: one run of your flow receives one batch (up to 100 leads) in
// the "Zoho CRM" format and creates or updates every lead of data.leads in the
// Zoho CRM Leads module, in one call to Zoho. Each lead arrives as a ready
// Leads record without empty fields, so it is sent as it is and an update
// never clears a field you already filled in.
//
// Setup:
// 1. In Zoho CRM, add two custom fields to the Leads module:
//    - "SMB Lead ID" (Single Line) with "Do not allow duplicate values" ticked.
//      Its API name must be SMB_Lead_ID.
//    - "SMB Is New" (Checkbox). Its API name must be SMB_Is_New.
//    If you do not add them, set useCustomFields to false below.
// 2. In Zoho Flow, create a connection to Zoho CRM that may create and update
//    leads (Zoho calls this permission the scope ZohoCRM.modules.ALL). Put its
//    link name in the invokeurl block below, in place of zohocrm_connection.
// 3. In Zoho Flow, create a custom function with return type map and one input
//    named payload of type map, and paste this script. In your flow, map
//    payload to the whole webhook trigger (${trigger}).
// 4. Set apiDomain below to your Zoho data center.
//
// How leads are matched (useCustomFields below):
// - true (with the two custom fields): by SMB_Lead_ID only. Every business
//   stays its own Lead, even when several businesses share one email (an
//   agency or a head office). A Lead you added to Zoho CRM in another way is
//   not matched, so that business can appear twice.
// - false: by Email only. Businesses that share an email become ONE Lead: the
//   last one exported overwrites its company name, phone and address. A lead
//   without an email is added again each time it is exported. Within one batch
//   SMB Sales Boost sends each email only once (a later lead with the same
//   email arrives without it).
//
// Size: Deluge allows 5,000 statements per function. This script runs about
// 7 statements per lead (about 10 with useCustomFields false), so about 750
// for a batch of 100 leads (about 1,050 with useCustomFields false). If Zoho
// Flow still reports that the function ran too long or too many statements,
// lower "Leads per batch" on the integration in SMB Sales Boost (for example
// to 50).

map exportLeadsToZohoCrm(map payload)
{
  // ---- Settings ----
  // Your Zoho data center: https://www.zohoapis.com (US), or the same address
  // ending in .eu, .in, .com.au, .jp, .ca, .com.cn or .sa. Use the ending of
  // your Zoho CRM address: crm.zoho.eu means https://www.zohoapis.eu
  apiDomain = "https://www.zohoapis.com";
  // true: match leads by SMB_Lead_ID (needs the two custom fields from Setup
  // step 1). false: match leads by Email ("How leads are matched" above).
  useCustomFields = true;
  // Sample batches (data.test is true) hold two made-up leads, Acme Test Co and
  // Beta Test Co. false: they are skipped, so they never reach Zoho CRM.
  // Set it to true once to test the whole flow, delete the two sample leads in
  // Zoho CRM afterwards, and set it back to false.
  sendSampleBatches = false;
  // true: your Zoho CRM workflow rules run for these leads as usual.
  runWorkflows = true;

  result = Map();

  // ---- Read the message ----
  // payload is the whole message. If the webhook trigger extracts "data",
  // payload is the batch itself.
  if(payload.get("data") != null)
  {
    if(payload.get("type") != "export.leads")
    {
      // Another event sent to the same URL: nothing to do.
      result.put("status","ignored");
      result.put("reason","Not an export.leads message");
      return result;
    }
    batch = payload.get("data").toString().toMap();
  }
  else
  {
    batch = payload;
  }
  if(batch.get("batchId") == null || batch.get("leads") == null)
  {
    result.put("status","ignored");
    result.put("reason","No batch in this message");
    return result;
  }
  if(batch.get("format") != "zoho_crm")
  {
    result.put("status","error");
    result.put("reason","This script needs the Zoho CRM format. Set Format to Zoho CRM on the integration in SMB Sales Boost.");
    return result;
  }
  if(ifnull(batch.get("test"),false).toString() == "true" && !sendSampleBatches)
  {
    result.put("status","skipped");
    result.put("reason","Sample batch (data.test is true). Set sendSampleBatches to true to write the sample leads.");
    return result;
  }

  // data.leads is normally a list; if it arrives as text, turn it into a list.
  leadsValue = batch.get("leads");
  leadsText = leadsValue.toString().trim();
  if(leadsText.startsWith("["))
  {
    leads = leadsText.toJSONList();
  }
  else
  {
    leads = leadsValue;
  }
  // Zoho takes up to 100 records per call, and a batch has at most 100 leads.
  if(leads.size() > 100)
  {
    result.put("status","error");
    result.put("reason","More than 100 leads in this batch. Set Leads per batch to 100 or less on the integration in SMB Sales Boost.");
    return result;
  }

  // ---- The records: each lead as it arrives ----
  records = List();
  if(useCustomFields)
  {
    for each leadItem in leads
    {
      records.add(leadItem.toString().toMap());
    }
  }
  else
  {
    // Without the custom fields, leave out the two fields Zoho CRM does not have.
    for each leadItem in leads
    {
      record = leadItem.toString().toMap();
      record.remove("SMB_Lead_ID");
      record.remove("SMB_Is_New");
      records.add(record);
    }
  }

  duplicateCheck = List();
  if(useCustomFields)
  {
    duplicateCheck.add("SMB_Lead_ID");
  }
  else
  {
    duplicateCheck.add("Email");
  }

  // ---- Send (one call for the whole batch) ----
  requestBody = Map();
  requestBody.put("data",records);
  requestBody.put("duplicate_check_fields",duplicateCheck);
  if(!runWorkflows)
  {
    requestBody.put("trigger",List());
  }
  response = invokeurl
  [
    url :apiDomain + "/crm/v8/Leads/upsert"
    type :POST
    parameters:requestBody.toString()
    headers:{"Content-Type":"application/json"}
    connection:"zohocrm_connection"
  ];
  answer = response.toString().toMap();
  results = answer.get("data");

  inserted = 0;
  updated = 0;
  failed = 0;
  errors = List();
  if(results == null)
  {
    // The whole call was refused, for example a connection without permission.
    failed = records.size();
    errors.add("Call refused: " + ifnull(answer.get("code"),"") + " " + ifnull(answer.get("message"),""));
  }
  else
  {
    // One result per record, in the order sent. A refused record comes back
    // inside an answer that otherwise looks successful, so check each one.
    position = 0;
    for each recordResult in results
    {
      if(recordResult.get("status") == "success")
      {
        if(recordResult.get("action") == "insert")
        {
          inserted = inserted + 1;
        }
        else
        {
          updated = updated + 1;
        }
      }
      else
      {
        failed = failed + 1;
        if(errors.size() < 20)
        {
          leadLabel = "";
          if(position < records.size())
          {
            sentRecord = records.get(position);
            leadLabel = ifnull(sentRecord.get("SMB_Lead_ID"),ifnull(sentRecord.get("Company"),""));
          }
          errors.add("Lead " + leadLabel + ": " + ifnull(recordResult.get("code"),"") + " " + ifnull(recordResult.get("message"),"") + " " + ifnull(recordResult.get("details"),"").toString());
        }
      }
      position = position + 1;
    }
  }

  // ---- Summary (shown in Zoho Flow's History) ----
  result.put("status","done");
  result.put("batch",batch.get("batchNumber").toString() + " of " + batch.get("batchCount").toString());
  result.put("batchId",batch.get("batchId"));
  result.put("leads",records.size());
  result.put("inserted",inserted);
  result.put("updated",updated);
  result.put("failed",failed);
  result.put("errors",errors);
  return result;
}

Script for Bigin by Zoho CRM

Use this script only if you use Bigin by Zoho CRM and the integration's Format is Bigin by Zoho CRM. For Zoho CRM, use the Script for Zoho CRM above.

How it works: the script creates or updates the companies, matched by Website, then the contacts, matched by Email and linked to their company. On Bigin Express or higher, tick "Do not allow duplicate values" for Website in Companies and for Email in Contacts. We have not confirmed how Bigin matches records when these fields are not unique (Bigin Free has no unique fields), so test it once: set sendSampleBatches to true, send the sample batch twice, check that Bigin shows one company per sample lead and one contact, then delete the sample records and set it back to false.

// SMB Sales Boost: "Exported leads (batched)" to Bigin by Zoho CRM
// Zoho Flow custom function (Deluge). BETA: written from Zoho's documentation,
// not yet tested against a live Zoho account.
//
// What it does: one run of your flow receives one batch (up to 100 leads) in
// the "Bigin by Zoho CRM" format. It creates or updates the Company of every
// lead of data.leads in one call to Bigin, then the Contacts (a lead has one
// only when it has a valid email) in a second call, each linked to its
// Company. Companies and contacts arrive without empty fields, so they are
// sent as they are and an update never clears a field you already filled in.
//
// Setup:
// 1. In Bigin (Express or higher), open the field settings and tick "Do not
//    allow duplicate values" for Website in Companies and for Email in
//    Contacts. The script asks Bigin to match companies by Website and
//    contacts by Email. We have not been able to confirm how Bigin matches
//    when these fields are not marked unique (Bigin Free has no unique
//    fields), so send the same sample batch twice and check that Bigin shows
//    one company and one contact per lead.
// 2. In Zoho Flow, create a connection to Bigin that may create and update
//    Companies and Contacts (Zoho calls this permission the scope
//    ZohoBigin.modules.ALL). Put its link name in BOTH invokeurl blocks
//    below, in place of bigin_connection. We have not been able to confirm
//    that a connection created in Zoho Flow includes this scope: if the
//    result shows OAUTH_SCOPE_MISMATCH or a permission error, that is the cause.
// 3. In Zoho Flow, create a custom function with return type map and one input
//    named payload of type map, and paste this script. In your flow, map
//    payload to the whole webhook trigger (${trigger}).
// 4. Set apiDomain below to your Zoho data center.
//
// Size: Deluge allows 5,000 statements per function. This script runs about
// 25 statements per lead with a contact and about 14 per lead without one, so
// about 2,500 for a batch of 100 leads. If Zoho Flow still reports that the
// function ran too long or too many statements, lower "Leads per batch" on
// the integration in SMB Sales Boost (for example to 50).

map exportLeadsToBigin(map payload)
{
  // ---- Settings ----
  // Your Zoho data center: https://www.zohoapis.com (US), or the same address
  // ending in .eu, .in, .com.au, .jp, .ca, .com.cn or .sa. Use the ending of
  // your Bigin address: bigin.zoho.eu means https://www.zohoapis.eu
  apiDomain = "https://www.zohoapis.com";
  // Sample batches (data.test is true) hold two made-up leads, Acme Test Co and
  // Beta Test Co. false: they are skipped, so they never reach Bigin.
  // Set it to true once to test the whole flow, delete the sample companies
  // and contact in Bigin afterwards, and set it back to false.
  sendSampleBatches = false;
  // true: your Bigin workflows run for these records as usual.
  runWorkflows = true;

  result = Map();

  // ---- Read the message ----
  // payload is the whole message. If the webhook trigger extracts "data",
  // payload is the batch itself.
  if(payload.get("data") != null)
  {
    if(payload.get("type") != "export.leads")
    {
      // Another event sent to the same URL: nothing to do.
      result.put("status","ignored");
      result.put("reason","Not an export.leads message");
      return result;
    }
    batch = payload.get("data").toString().toMap();
  }
  else
  {
    batch = payload;
  }
  if(batch.get("batchId") == null || batch.get("leads") == null)
  {
    result.put("status","ignored");
    result.put("reason","No batch in this message");
    return result;
  }
  if(batch.get("format") != "bigin")
  {
    result.put("status","error");
    result.put("reason","This script needs the Bigin format. Set Format to Bigin by Zoho CRM on the integration in SMB Sales Boost.");
    return result;
  }
  if(ifnull(batch.get("test"),false).toString() == "true" && !sendSampleBatches)
  {
    result.put("status","skipped");
    result.put("reason","Sample batch (data.test is true). Set sendSampleBatches to true to write the sample leads.");
    return result;
  }

  // data.leads is normally a list; if it arrives as text, turn it into a list.
  leadsValue = batch.get("leads");
  leadsText = leadsValue.toString().trim();
  if(leadsText.startsWith("["))
  {
    leads = leadsText.toJSONList();
  }
  else
  {
    leads = leadsValue;
  }
  // Bigin takes up to 100 records per call, and a batch has at most 100 leads.
  if(leads.size() > 100)
  {
    result.put("status","error");
    result.put("reason","More than 100 leads in this batch. Set Leads per batch to 100 or less on the integration in SMB Sales Boost.");
    return result;
  }

  companiesInserted = 0;
  companiesUpdated = 0;
  companiesFailed = 0;
  contactsInserted = 0;
  contactsUpdated = 0;
  contactsFailed = 0;
  contactsWithoutCompany = 0;
  errors = List();

  // ---- 1. Companies: each lead's company as it arrives ----
  leadMaps = List();
  companies = List();
  for each leadItem in leads
  {
    lead = leadItem.toString().toMap();
    leadMaps.add(lead);
    companies.add(lead.get("company").toString().toMap());
  }
  companyBody = Map();
  companyBody.put("data",companies);
  companyCheck = List();
  companyCheck.add("Website");
  companyBody.put("duplicate_check_fields",companyCheck);
  if(!runWorkflows)
  {
    companyBody.put("trigger",List());
  }
  companyResponse = invokeurl
  [
    url :apiDomain + "/bigin/v2/Accounts/upsert"
    type :POST
    parameters:companyBody.toString()
    headers:{"Content-Type":"application/json"}
    connection:"bigin_connection"
  ];
  companyAnswer = companyResponse.toString().toMap();
  companyResults = companyAnswer.get("data");

  // The company id of each lead, in the same order as the leads ("" when the
  // company was not saved). Zoho's examples return one result per record in
  // the order sent; if the count differs, contacts are saved unlinked.
  companyIds = List();
  if(companyResults == null)
  {
    companiesFailed = companies.size();
    errors.add("Companies refused: " + ifnull(companyAnswer.get("code"),"") + " " + ifnull(companyAnswer.get("message"),""));
    for each lead in leadMaps
    {
      companyIds.add("");
    }
  }
  else if(companyResults.size() != companies.size())
  {
    errors.add("Bigin returned " + companyResults.size().toString() + " company results for " + companies.size().toString() + " companies, so contacts were not linked.");
    for each lead in leadMaps
    {
      companyIds.add("");
    }
  }
  else
  {
    // A refused record comes back inside an answer that otherwise looks
    // successful, so check each one.
    position = 0;
    for each companyResult in companyResults
    {
      if(companyResult.get("status") == "success")
      {
        companyIds.add(companyResult.get("details").get("id"));
        if(companyResult.get("action") == "insert")
        {
          companiesInserted = companiesInserted + 1;
        }
        else
        {
          companiesUpdated = companiesUpdated + 1;
        }
      }
      else
      {
        companyIds.add("");
        companiesFailed = companiesFailed + 1;
        if(errors.size() < 20)
        {
          errors.add("Company of lead " + ifnull(leadMaps.get(position).get("smbLeadId"),"") + ": " + ifnull(companyResult.get("code"),"") + " " + ifnull(companyResult.get("message"),"") + " " + ifnull(companyResult.get("details"),"").toString());
        }
      }
      position = position + 1;
    }
  }

  // ---- 2. Contacts: each contact as it arrives, linked to its company by position ----
  contacts = List();
  contactLeadIds = List();
  position = 0;
  for each lead in leadMaps
  {
    // contact is null when the lead has no valid email.
    contactText = ifnull(lead.get("contact"),"").toString();
    if(contactText != "" && contactText != "null")
    {
      contact = contactText.toMap();
      companyId = companyIds.get(position);
      if(companyId != "")
      {
        contact.put("Account_Name",{"id":companyId});
      }
      else
      {
        contactsWithoutCompany = contactsWithoutCompany + 1;
      }
      contacts.add(contact);
      contactLeadIds.add(lead.get("smbLeadId"));
    }
    position = position + 1;
  }
  if(contacts.size() > 0)
  {
    contactBody = Map();
    contactBody.put("data",contacts);
    contactCheck = List();
    contactCheck.add("Email");
    contactBody.put("duplicate_check_fields",contactCheck);
    if(!runWorkflows)
    {
      contactBody.put("trigger",List());
    }
    contactResponse = invokeurl
    [
      url :apiDomain + "/bigin/v2/Contacts/upsert"
      type :POST
      parameters:contactBody.toString()
      headers:{"Content-Type":"application/json"}
      connection:"bigin_connection"
    ];
    contactAnswer = contactResponse.toString().toMap();
    contactResults = contactAnswer.get("data");
    if(contactResults == null)
    {
      contactsFailed = contacts.size();
      errors.add("Contacts refused: " + ifnull(contactAnswer.get("code"),"") + " " + ifnull(contactAnswer.get("message"),""));
    }
    else
    {
      position = 0;
      for each contactResult in contactResults
      {
        if(contactResult.get("status") == "success")
        {
          if(contactResult.get("action") == "insert")
          {
            contactsInserted = contactsInserted + 1;
          }
          else
          {
            contactsUpdated = contactsUpdated + 1;
          }
        }
        else
        {
          contactsFailed = contactsFailed + 1;
          if(errors.size() < 20)
          {
            leadLabel = "";
            if(position < contactLeadIds.size())
            {
              leadLabel = ifnull(contactLeadIds.get(position),"");
            }
            errors.add("Contact of lead " + leadLabel + ": " + ifnull(contactResult.get("code"),"") + " " + ifnull(contactResult.get("message"),"") + " " + ifnull(contactResult.get("details"),"").toString());
          }
        }
        position = position + 1;
      }
    }
  }

  // ---- Summary (shown in Zoho Flow's History) ----
  result.put("status","done");
  result.put("batch",batch.get("batchNumber").toString() + " of " + batch.get("batchCount").toString());
  result.put("batchId",batch.get("batchId"));
  result.put("leads",leads.size());
  result.put("companiesInserted",companiesInserted);
  result.put("companiesUpdated",companiesUpdated);
  result.put("companiesFailed",companiesFailed);
  result.put("contactsInserted",contactsInserted);
  result.put("contactsUpdated",contactsUpdated);
  result.put("contactsFailed",contactsFailed);
  result.put("contactsWithoutCompany",contactsWithoutCompany);
  result.put("errors",errors);
  return result;
}

API reference

Ready to Find Your Next Customers? Get access to growing local business leads updated every 5 minutes. See plans starting at $49/mo →