AckdbContactMappingInput
Maps event content fields to a contact (person) extracted at ingest time. A durable external ID is required; display name, email, title, and other person properties are optional.
Properties
rolestringrequiredContact's role for this mapping (e.g. `user`, `attendee`).
nameFieldstringOptional content field holding the contact's display name. Omit when a durable person key such as LinkedIn URL is the only person data this source owns.
emailFieldstringContent field holding the contact's email.
titleFieldstringContent field holding the contact's job title.
externalIdFieldstringrequiredContent field holding the contact's external ID value.
externalIdTypestringrequiredExternal ID type for the contact (e.g. `app_user_email`).
linkedinUrlFieldstringContent field holding the contact's LinkedIn URL.
phoneFieldstringContent field holding the contact's phone number.
departmentFieldstringContent field holding the contact's department.
excludeWhenobjectSkip extracting this contact when these field/value conditions match.
startedAtFieldstringContent field holding when the EMPLOYMENT began (#345) — a fact, never inferred from ingest order.
endedAtFieldstringContent field holding when the employment ENDED (#345); a value flips the edge to `former`.
externalIdScopestringWhat `externalIdField` identifies: the HUMAN (a durable person key) or the AFFILIATION (a workspace-local seat id, match-only). Default `affiliation`.
"person""affiliation"endsPriorbooleanThis event asserts the human's OTHER affiliations have ended (job-change semantics): their other active edges flip to `former` with a `contact.ended` each. Person-scope event types only. Default false.
isPrimarybooleanThe resolved edge becomes the person's PRIMARY affiliation (#544, `primarySource: ingest`; sticky while that edge is active). Applied only when the edge is ACTIVE. Person-scope event types only. Default false.
Example
{
"role": "string",
"nameField": "string",
"emailField": "string",
"titleField": "string",
"externalIdField": "string",
"externalIdType": "string",
"linkedinUrlField": "string",
"phoneField": "string",
"departmentField": "string",
"excludeWhen": {},
"startedAtField": "string",
"endedAtField": "string",
"externalIdScope": "person",
"endsPrior": false,
"isPrimary": false
}