Skip to content

shell-crm Sensor ​

What it ingests ​

CRM records from your Shell CRM: companies, contacts, deals, partnerships, opportunities, contracts, and follow-ups. It also reads activity on those records — comments, new follow-ups, contacts added to a deal, email opens, and record updates — and the who-knows-who relationships stored on contacts.

Read-only. A failure reading one record type does not stop the others.

Credential ​

References a shellcrm_api_key credential by id. The secret is a Shell CRM API key: a client_id:client_secret string, sent as the Bearer token on every call. Have a Shell CRM admin issue an API client with read access to the records this sensor should see, and store the issued client_id:client_secret as the secret.

bash
curl -sS -X POST https://your-corveil-host/api/credentials \
  -H "Authorization: Bearer <admin>" -H "Content-Type: application/json" \
  -d '{"type":"shellcrm_api_key","name":"acme-crm-key","secret":"<client_id>:<client_secret>"}'

Config fields ​

KeyRequiredNotes
base_urlyesRoot URL of your Shell CRM (no trailing slash). Use https.
enabled_entitiesnoComma-separated record types. Blank reads every supported type. Unknown names are rejected when you save. Who-knows-who relationships are included when contacts are enabled.
default_entity_typenoOverride the graph entity type produced from each record. Blank uses the per-record fallback (Organization for companies, Project for deals, and so on). Checked against your org's types on save.

Supported record types: companies, contacts, deals, partnerships, opportunities, contracts, follow-ups.

Provider-side setup ​

  1. In Shell CRM, have an admin issue an API client with read access to the records this sensor should see.
  2. Copy the issued client_id:client_secret — that's the API key secret above.
  3. Note the deployment's base URL for base_url.

Wire-up ​

POST /api/sensors

json
{
  "sensor_type": "shellcrm",
  "name": "Acme CRM",
  "config": {
    "base_url": "https://crm.acme.com",
    "enabled_entities": "companies, deals, contacts"
  },
  "credentials": { "api_key": "<shellcrm_api_key credential id>" }
}

Verify ​

Run Test connection to confirm the base URL and API key authenticate. Once polling, records from the enabled types appear in the graph.