SugarCRM

Datafly Signal delivers identified-user events to SugarCRM server-to-server using the Sugar REST API. When a visitor identifies themselves (form submission, sign-up, gated download), Signal creates a record in your chosen Sugar module — typically Leads — with the user’s traits, the lead source, and a marketing opt-out flag derived from consent.

Prerequisites

Before configuring SugarCRM in Signal you need a Sugar instance (SugarCloud or on-site), a dedicated API user, and an OAuth client key.

Step 1: Note Your Instance URL

Your instance URL is the base address of your Sugar deployment, with no trailing slash:

• SugarCloud: https://<yourcompany>.sugarondemand.com
• On-site: your Sugar server URL (e.g. https://crm.example.com)

All REST API calls are made under <instance_url>/rest/<version>/.

Step 2: Create a Dedicated API User

1. In Sugar, go to Admin > User Management > Create New User.
2. Create a regular user (e.g. signal-integration) with a strong password.
3. Grant it a role with create and edit access to the module(s) you will write to (Leads and/or Contacts).

Step 3: Confirm an OAuth Client Key

Sugar’s REST API authenticates with OAuth2. Most instances have a default client with client_id = sugar and an empty secret. To use a dedicated key:

1. Go to Admin > OAuth Keys > Create OAuth Key.
2. Set a Consumer Key (this is your client_id) and optionally a Consumer Secret.
3. Set OAuth Version to OAuth 2.0.

Step 4: Choose a Platform Name

The OAuth token request requires a platform value. It must not be base, mobile, or portal — using those can log out interactive sessions. Pick a unique name such as datafly_signal.

Configure in Signal

Configuration Fields

Management UI Setup

API Endpoint

Signal authenticates with the OAuth2 password grant, then creates records with the standard Sugar “create a record” resource.

Token request:

POST {instance_url}/rest/{api_version}/oauth2/token
Content-Type: application/json

{
  "grant_type": "password",
  "client_id": "sugar",
  "client_secret": "",
  "username": "signal-integration",
  "password": "••••••••",
  "platform": "datafly_signal"
}

The response carries an access_token (default lifetime 3600s), token_type of bearer, and a refresh_token. Signal sends the token on every create as a standard bearer header (Authorization: Bearer <access_token>), supported by the Sugar REST API since the Fall ‘18 release.

Create request:

POST {instance_url}/rest/{api_version}/{module}
Authorization: Bearer {access_token}
Content-Type: application/json

Identity Signals

SugarCRM is a system of record, not an advertising platform, so Signal sends identity traits in plain text (not hashed) — they are written directly into Sugar fields you will read in the CRM UI.

Consent → Opt-Out

Sugar’s email array carries an opt_out flag. Signal maps your canonical marketing consent to it:

How to Send User Data

Call datafly.identify() when a user submits a form, registers, or logs in, then track the conversion:

datafly.identify("user-123", {
  first_name: "Jane",
  last_name: "Doe",
  email: "jane.doe@example.com",
  phone: "+44 7700 900123",
  title: "Head of Marketing",
  company: "Acme Ltd",
  website: "https://acme.example.com"
});

Event Mapping

Lead Capture preset

Identity traits map globally on every delivered event; the per-event mappings add lead_source, description, and campaign attribution.

Example: Lead Generated

Datafly.js call:

datafly.identify("user-123", {
  first_name: "Jane",
  last_name: "Doe",
  email: "jane.doe@example.com",
  phone: "+44 7700 900123",
  company: "Acme Ltd",
  title: "Head of Marketing"
});
 
datafly.track("Lead Generated", {
  lead_source: "Web Site",
  description: "Requested a demo via the pricing page"
});

SugarCRM payload sent by Signal (POST /rest/v11_24/Leads):

{
  "first_name": "Jane",
  "last_name": "Doe",
  "phone_mobile": "+44 7700 900123",
  "title": "Head of Marketing",
  "account_name": "Acme Ltd",
  "lead_source": "Web Site",
  "description": "Requested a demo via the pricing page",
  "email": [
    {
      "email_address": "jane.doe@example.com",
      "primary_address": "1",
      "opt_out": "0"
    }
  ]
}

A successful create returns HTTP 200 with the new record, including its generated id.

Testing

Troubleshooting