Skip to main content

InboundRecordSourceConfig

@gravity-rail/sdk

@gravity-rail/sdk / InboundRecordSourceConfig

Interface: InboundRecordSourceConfig

One remote record source synced inbound into a builder-chosen Form.

Each remote item (a form submission, a deal) becomes one record of the collection Form dataTypeId, keyed by the item's remote id, owned by the linked Member of the item's contact. Each new remote item (a second submission, another deal) is its own record; a changed item updates its own record. kind is one of the connector's declared inbound_record_kinds; sourceId names the remote source when the kind has several (a form's id). properties are the remote properties a kind that needs them fetches (deal properties).

rules use the SyncRule model, inbound only: a form_field op's targetKey is a field slug of this source's Form (the Form is fixed by dataTypeId, so no Form reference); a managed_field op writes the linked Member's connection field, as on the Member entity. Saving binds the Form to the connection as dataset inbound_<key> (sync/inbound_records.py).

Properties​

dataTypeId​

dataTypeId: number

Exclusive Minimum​

0

enabled?​

optional enabled: boolean

key​

key: string

Pattern​

^[a-z0-9]{1,32}$

kind​

kind: string

Min Length​

1

Max Length​

64

properties?​

optional properties: string[]

Max Items​

200

rules?​

optional rules: SyncRule[]

sourceId?​

optional sourceId: string | null

sourceLabel?​

optional sourceLabel: string | null