Integrations

Integrations (integrations:manage) deliver job events somewhere else. GET /v1/integrations/catalog lists the types, each with the JSON Schema of its config, its events and the module it needs.

Type	Module	Does
`crm_push_generic`	`crm_sync`	Sends a summary of each job event to your CRM’s REST endpoint, mapped field by field.
`hubspot`	`crm_sync`	Creates or updates the deal in HubSpot, connected over OAuth.
`salesforce`	`crm_sync`	Upserts the record (an `Opportunity` by default) in Salesforce, connected over OAuth.
`slack`	`notifications`	Posts review-required and failure alerts, with the reasons and a link to the result.
`webhook`		The same as `/v1/webhooks`.

A generic CRM endpoint

config.field_mapping maps target fields (dots nest) to paths into event, job and result; without one, the event’s summary is sent as is. secrets.authorization is the Authorization header to send; it is write-only and stored encrypted.

curl -sS -X POST "$API/v1/integrations" -H "X-API-Key: $KEY" -H "Content-Type: application/json" -d '{
  "type": "crm_push_generic", "name": "Our CRM",
  "config": {"url": "https://crm.example.com/api/deals",
             "field_mapping": {"deal.monthly_revenue": "result.underwriting.avg_monthly_revenue",
                               "deal.status": "job.status"}},
  "secrets": {"authorization": "Bearer crm-token"}}'

HubSpot and Salesforce

Installing answers an authorize_url. The integration stays pending until the person’s consent returns. Then each job event creates or updates the deal:

HubSpot finds the deal by match_field (default parser_merchant_id, the merchant’s fingerprint).
Salesforce upserts object (default Opportunity) by its external-id field.

field_mapping sets the CRM’s fields from the result (underwriting, status, positions), result_link_field the result’s URL, and defaults the fields every update carries. If the provider later refuses the grant, the integration becomes reauth_required; POST /v1/integrations/{id}/connect gives a new consent link, and the events in between are delivered once it is back.

Delivery

Each event an integration takes becomes a run. 5xx, 429 and timeouts are retried on the webhook schedule; a 4xx ends the run as dead. GET /v1/integrations/{id}/runs shows every run, and POST /v1/integrations/{id}/test sends a ping. Targets must be https on public addresses.

Modules

Modules switch parts of the pipeline per tenant, and are all on by default: underwriting, positions, fraud, email_intake, email_routing, crm_sync and notifications. A module that is off is not computed: its section of the result is empty, result.pipeline.modules_off names it, and its routes answer 403. GET /v1/modules shows yours.

Get started

Concepts

Guides

A generic CRM endpoint

HubSpot and Salesforce

Delivery

Modules

​A generic CRM endpoint

​HubSpot and Salesforce

​Delivery

​Modules

A generic CRM endpoint

HubSpot and Salesforce

Delivery

Modules