CRM and Data Sync Connections
Salesforce, HubSpot, monday.com, Confluence, and Zendesk Help Center use the App Connections area to authorize an account and configure synchronization. The connection-specific UI walkthroughs live in the App Connections user guide. This page summarizes the developer-facing sync contract and where each provider fits.
Supported mappings
| Provider | Gravity Rail target | Match options | Inbound target options | Conflict choices |
|---|---|---|---|---|
| Salesforce | Members; Form records (outbound only) | Email, phone, or existing link | Member property, managed field, Member label, or notification opt-out | Remote wins, keep local |
| HubSpot | Members or Form records | Email, phone, or existing link | Member property, managed field, or notification opt-out; record sources map values to Form fields | Remote wins, keep local |
| monday.com | Members or Form records | Email, phone, external ID, existing link, or custom | Member property, managed field, or Form field | Remote wins, keep local |
| Confluence | Files | Existing link | No Member or Form target | Remote wins |
| Zendesk Help Center | Files | Existing link | No Member or Form target | Remote wins |
Match and target options are connector-specific. A mapping must use an option supported by that connection. "Remote wins" is the remote_wins conflict mode and "Keep local" is skip; a save naming a mode the connection does not list is refused. GET /app-connections/{id}/sync-capabilities reports what a connection supports, and connectionEnabled says whether that connection is enabled: inboundTargetsByContext gives the inbound targets each mapping context accepts (member_entity, record_board, related_object, and inbound_record for a connector's record sources — form_field plus managed_field, empty when the connector has no record sources), and defaultConflictMode names the mode an entity with no saved conflict policy gets. requiredEntityTypes lists the entity types a connection cannot be configured without: the member entity on Salesforce, HubSpot and every sync-capable FHIR vendor. A save that removes one is refused with the code required_entity_type_removed; turn that entity's sync directions off instead. A save that sends data out also needs read access to what it sends: members:read for a Member mapping, labels:read for a label read (a whole source.labels read included), and read access to the Form plus unrestricted records:read for a Form-record export. A save whose outbound mappings read something the saving Member may not read is refused with outbound_read_forbidden (HTTP 403), and one that reads something that cannot be checked, such as a computed key or index into source, fields or a Form, a whole source, fields or Form map, or a Form or field that no longer exists, with outbound_read_unresolved (HTTP 400); the message names the mapping position only. Each field a mapping reads must be readable by the saver, not only the Form, and every save re-checks every read, unchanged ones included, so a configuration can start refusing after an unrelated edit by a Member with narrower access. To recover, remove or disable that read, turn off that mapping's outbound direction, or have a Member who holds the read access save the configuration. For API-driven Member creation or Form imports, see Creating Members and Importing Data.
Salesforce
Salesforce synchronization targets Members. Match an incoming record by email, phone, or an existing record link; inbound rules can update supported Member properties, connection-managed fields, or labels, and can turn a Member's SMS, voice, email or WhatsApp notifications off when a record has opted out (never back on). Salesforce can also send Form records, outbound only: each record of a mapped Form creates one record of a chosen Salesforce object and then updates it. The only value read back for a Form record is the linked record Id, and only when the mapping sets a write-back target (remoteIdField); the match and inbound target options in the table apply to Members. The connection also exposes task and activity logging operations. For Salesforce-side API and OAuth concepts, see Salesforce REST API authorization.
HubSpot
HubSpot synchronization targets Members and supports the same email, phone, and existing-link matching choices as Salesforce. Inbound rules can update supported Member properties or connection-managed fields, and can turn a Member's notification channels off from a HubSpot opt-out (never back on). Form submissions, booking-link meetings, deals and custom objects can also write records into a member-scoped collection Form. Each record belongs to the Member linked to its HubSpot contact; these sources do not create Members. A custom-object source reads only the objects associated with contacts already linked to Members, and removes a record when HubSpot deletes its object or no longer associates it with the contact. It removes only records it wrote. Map at least one value to a Form field, then optionally map values to Member fields too. HubSpot also supports logging chat notes and CRM activity. For app authentication and object APIs, see HubSpot developer documentation.
The workspace API exposes these read-only endpoints under /api/v2/w/{workspace_uuid}/app-connections (scope apps:read):
| Endpoint | Result |
|---|---|
GET /hubspot/sync-settings/forms | HubSpot forms and their submitted fields; status: missing_scope when the optional forms permission is absent. |
GET /hubspot/sync-settings/meeting-links | HubSpot booking links; status: missing_scope when the optional scheduler permission is absent. |
GET /hubspot/sync-settings/crm-objects | The portal's live custom objects with their readable properties; status is ok, missing_scope or unavailable. |
GET /{connectionId}/inbound-records/status | Each configured source's latest closed status and counts (written, skippedUnlinked, removed), without its paging cursor. |
Form and booking-link listings report truncated: true when the catalog exceeds their page cap. GET /hubspot/sync-settings/hs-properties?objectType=deals lists deal properties; omitting objectType lists contact properties.
monday.com
monday.com supports both Member and Form-record mappings. Use a Member target for one item per person, or a Form target when an item represents a record associated with a Member. Matching can use email, phone, external ID, an existing link, or a custom rule. For board and column data structures, see the monday.com API reference.
Confluence
Confluence synchronizes files. It uses existing links to match content and applies remote-wins conflict handling. It does not create or update Members or Form records. See the Confluence Cloud REST API for provider content resources and OAuth 2.0 (3LO) for Atlassian authorization concepts.
Zendesk Help Center
A Zendesk Help Center connection mirrors the published articles of selected categories of a public Help Center, in one locale, into a folder: one Markdown File per article plus its downloaded screenshots. It is inbound only and needs no Zendesk credential; articles are read through the Help Center's public Articles API on <subdomain>.zendesk.com.
- Create with
POST /api/v2/w/{workspace_uuid}/app-connections/zendesk/configure(scopeapps:write). The body carries the completesettings—sourceSlug,helpCenterUrl,zendeskSubdomain,locale,categoryIds(one or more),destinationFolderId(an existing folder both you and the sync owner can add Files to), optionalinboundPollIntervalMinutesanddeleteRemoved— and an optionalname. The caller becomes the sync owner, and the connection is created with its onefileentity paused. The SDK method isconfigureZendeskConnection. - Edit, pause and resume through the generic
GET/PUT /app-connections/{id}/sync-config: settings live inconnectionParams, and pause/resume is thefileentity'sinboundEnabled. Creation and edits run the same validation, and neither contacts Zendesk. Send theconfigDigestfrom theGETback as?baseConfigDigest=on thePUT(the SDK'supdateConnectionSyncConfigoptionbaseConfigDigest): if the configuration changed since you read it, the save is refused with HTTP 409sync_config_changed, and you re-read, reapply your change and save again. - Run with the generic
POST /app-connections/{id}/sync/run. A run is always a complete persisted reconciliation:dryRun,recordLimitandboardIdare refused with HTTP 400, andGET /sync-capabilitiesreportssupportsDryRun,supportsRecordLimitandsupportsBoardScopeasfalse.resetCheckpoints: truere-renders every article. The workspace runs it once a day while resumed. - History comes from the generic
/sync/runsroutes. Each item is one article (entityType: "file",localIdthe File); deletions happen only after a complete listing.
Member identity and data ownership
Use a stable external record link when the connector has already matched or linked a record; an email or phone match is a matching rule, not a permanent external identity. When syncing inbound fields, choose the specific writable Member property or managed field exposed by the connector. To review the shared Member schema and import/export contracts, use the Members API, Data Records API, and Exporting Data.
Related
- App Connections — authorize providers and configure sync mappings.
- Creating Members — create and identify Members.
- Importing Data — reconcile incoming records.
- Exporting Data — export workspace data.