- Connect —
POSTwith credentials to verify and save the integration. - Check status —
GETto see whether the integration is active. - Disconnect —
DELETEto deactivate.
enrich object in the POST body to trigger immediate enrichment of a specific record.
POST /api/v1/integrations/salesforce
Requires Bearer token.
| Field | Type | Required | Description |
|---|---|---|---|
instance_url | string | ✓ | Salesforce instance URL (*.salesforce.com or *.force.com). |
access_token | string | ✓ | OAuth access token. |
refresh_token | string | ✓ | OAuth refresh token. |
object_type | string | ✓ | Target object: Lead, Account, Opportunity, or Custom. |
enrich | object | Optional. Enrich a record immediately on setup. |
| Salesforce field | Description |
|---|---|
Axiom_Score__c | Composite score (0–100). |
Axiom_Safety_Level__c | Safety assessment level. |
Axiom_Permit_Momentum__c | Permit activity momentum indicator. |
Axiom_Fragility_Score__c | Supply chain fragility score. |
Axiom_Profile__c | Scoring profile used. |
Axiom_Permits_12m__c | Permit count over the last 12 months. |
Axiom_Neighborhood__c | Resolved neighborhood name. |
Axiom_Enriched_At__c | Timestamp of last enrichment. |
POST /api/v1/integrations/hubspot
Requires Bearer token.
| Field | Type | Required | Description |
|---|---|---|---|
access_token | string | ✓ | OAuth token or private app token. |
refresh_token | string | Required for OAuth flows. Omit for private app tokens. | |
object_type | string | ✓ | Target object: contacts, companies, or deals. |
enrich | object | Optional. Enrich a record immediately. Include record_id and address or company. |
axiom_score, axiom_safety, axiom_permit_activity, axiom_fragility, axiom_profile, axiom_permits_12m, axiom_neighborhood, axiom_enriched_at
Example
POST /api/v1/integrations/dynamics
Requires Bearer token.
| Field | Type | Required | Description |
|---|---|---|---|
tenant_id | string | ✓ | Azure AD tenant ID. |
client_id | string | ✓ | App registration client ID. |
client_secret | string | ✓ | App registration client secret. |
resource_url | string | ✓ | Dynamics instance URL (must end in .dynamics.com or .crm.dynamics.com). |
entity_type | string | ✓ | Dynamics entity logical name (e.g. lead, account, opportunity). |
enrich | object | Optional. Enrich a record immediately. Include record_id and address or company. |
POST /api/v1/integrations/zoho
Requires Bearer token.
| Field | Type | Required | Description |
|---|---|---|---|
access_token | string | ✓ | Zoho OAuth access token. |
refresh_token | string | ✓ | Zoho OAuth refresh token. |
api_domain | string | API domain. Defaults to https://www.zohoapis.com. Also accepts .zoho.com or .zohoapis.eu. | |
module | string | Target module: Leads, Accounts, Contacts, or Deals. Defaults to Leads. | |
enrich | object | Optional. Enrich a record immediately. Include record_id and address or company. |
POST /api/v1/integrations/zendesk
Requires Bearer token.
| Field | Type | Required | Description |
|---|---|---|---|
subdomain | string | ✓ | Your Zendesk subdomain (e.g. mycompany for mycompany.zendesk.com). |
api_token | string | ✓ | Zendesk API token. |
email | string | ✓ | Admin email address for authentication. |
enrich | object | Optional. Enrich a ticket immediately. Include ticket_id and address or facility. |
- Adds a private internal note on the ticket with composite score, safety level, and neighborhood data.
- Sets custom ticket fields:
axiom_scoreandaxiom_safety.
POST /api/v1/integrations/zapier
Requires Bearer token.
| Field | Type | Required | Description |
|---|---|---|---|
webhook_url | string | ✓ | HTTPS webhook URL to receive events. |
trigger_events | array | Event types to forward. Defaults to all. | |
format | string | Payload format: json (default) or form (form-urlencoded). | |
name | string | Friendly name. Defaults to Zapier Webhook. | |
enrich | object | Optional. Push an enrichment payload immediately. Include address, company, or facility. |
| Event | Description |
|---|---|
hotspot_detected | A new permit or activity hotspot appears. |
fragility_spike | Supply chain fragility score spikes for a company. |
rule_change | Zoning or regulatory rule change detected. |
permit_surge | Permit filing rate exceeds normal levels. |
score_change | Composite score changes significantly. |
shortage_alert | Drug shortage or supply disruption detected. |
Managing integrations
All integration endpoints supportGET and DELETE methods for status checks and deactivation.
Check status
Deactivate
POST /api/v1/keys
Requires Bearer token.
al_ and can be scoped to specific endpoints.
Request body
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | ✓ | Action: create, list, or revoke. | |
name | string | Human-readable key name (required for create). | ||
scopes | array | Endpoint scopes. Omit for full access. | ||
key_id | string | Key ID to revoke (required for revoke action). |
| Field | Type | Description |
|---|---|---|
key.id | string | Key identifier for management operations. |
key.token | string | Full API key (only shown once on creation). |
key.scopes | array | Endpoint scopes this key can access. |