docs(audiences): document field-level write rules for Salesforce export#1617
Merged
Merged
Conversation
Add explanation of Never write / Always write / Write if empty rules to the "Writing back to your CRM" section, including that Never write is the default for all newly mapped fields.
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Added a Field-level write rules table to
docs/audiences.mdin the "Writing back to your CRM" section. The table defines the three export write rules for Salesforce field mappings — Never write (default), Always write, and Write if empty — explains what each does, how to change them (click the pencil icon), and calls out that "Never write" is the default for all newly added field mappings.Why
Intercom conversation #215475130065193 (Saviynt / Gabriel Griffith): Customer had mapped fields to Salesforce on the Accounts object and was confused about why data wasn't syncing. A human admin (Peter Johnston) resolved it by explaining that the Export sync toggle must be enabled as the master switch, and that the first export runs within the next 24-hour window. The existing FAQ ("I've mapped fields to Salesforce but the data isn't syncing — why?") already covers the master toggle correctly. However, nowhere in the doc are the three field-level write rules defined — they are referenced by name but never explained. A customer who maps new fields but doesn't know "Never write" is the default would not know to change the rule, and the doc currently gives no guidance on this.
Why this is materially new vs. PR #1615: PR #1615 (also open on this file) mentions the three rule names in a troubleshooting FAQ ("Field-level write rules (Always write, Write if empty, Never write) control which fields get pushed...") but does not define them, does not explain that "Never write" is the default, and does not show the behavioral table. This PR adds that explanatory content to the main setup section.
Source link(s)
/workspace/clay-base/libs/api-contract/src/audiences/lib/import-types.ts:38-42—MappingRule.AlwaysWrite = 'ALWAYS_WRITE',MappingRule.WriteIfEmpty = 'WRITE_IF_EMPTY',MappingRule.NeverWrite = 'NEVER_WRITE'/workspace/clay-base/apps/frontend/src/components/Audiences/utils/AudienceMappingHelpers.ts:20—export const DEFAULT_MAPPING_RULE = MappingRule.NeverWrite;getDisplayTextForMappingRulereturns'Always write','Write if empty','Never write'for each enum valueUncertainties
None — all behavioral claims (write rules definition, Never write as default, UI display names) verified PASS by verifier sub-agent and direct code inspection against the above file:line citations.
Related observations
docs/audiences.mdand mentions write rules by name in a troubleshooting FAQ, but does not define them or note the default. Reviewer should reconcile these two additions at merge time to avoid redundancy (e.g. the write rules table from this PR could become the canonical reference that the FAQ in docs(audiences): add Export sync toggle prerequisite for Salesforce write-back #1615 links to).Closes DOC-1224