- 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.
Enrichment fields pushed to Salesforce:
Example
POST /api/v1/integrations/hubspot
Requires Bearer token.
Enrichment properties pushed to HubSpot:
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.
Example
POST /api/v1/integrations/zoho
Requires Bearer token.
Example
POST /api/v1/integrations/zendesk
Requires Bearer token.
Enrichment behavior:
- 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.
Available trigger events:
Example
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
Example