Documentatie

Contacteigenschappen

Definieer aangepaste velden voor contacten — zoals accounttype, regio of contractniveau — en geef ze door via de widget. Eigenschappen worden getoond op het profiel van het contact, kunnen door medewerkers worden bewerkt en zijn filterbaar in de Inbox.

Overzicht#

Met Contacteigenschappen kun je gestructureerde data aan gesprekken koppelen, naast de ingebouwde velden (email, naam, userId). Anders dan vrije metadata hebben eigenschappen een gedefinieerd schema met types, labels en validatie — vergelijkbaar met aangepaste velden in HubSpot of Salesforce.

Schema definiëren

Maak eigenschapsdefinities in de Agentinstellingen met types als string, number, enum, boolean, date, url

Doorgeven vanuit de widget

Stuur eigenschapswaarden via Respondo.identify() — ze worden automatisch opgeslagen en weergegeven

Filteren & bewerken

Filter gesprekken op eigenschapswaarden in de Inbox. Medewerkers kunnen de attributen van een contact bekijken en bewerken op het contactprofiel.

Eigenschappen definiëren#

Eigenschappen worden per agent gedefinieerd in Agentinstellingen → Contacteigenschappen. Elke eigenschap heeft:

VeldBeschrijving
keyUnieke identifier die in code wordt gebruikt. Automatisch gegenereerd uit het label (bewerkbaar). Kleine letters, cijfers en underscores; moet met een letter beginnen; 2-63 tekens. Systeemsleutels (user_id, visitor_id, timezone, page_url, …) zijn gereserveerd. Voorbeeld: account_type
labelLeesbare naam die in het dashboard wordt getoond. Voorbeeld: "Account Type"
typeType waarde: string, number, boolean, enum, date, url
enum_valuesVoor het type enum — lijst met toegestane waarden. Voorbeeld: ["starter", "pro", "enterprise"]
is_filterableGereserveerd voor toekomstige filterregeling; wordt met de definitie opgeslagen, maar de filterkiezer van de Inbox toont momenteel alle gedefinieerde eigenschappen (standaard: true)
is_visibleGereserveerd voor toekomstige weergaveregeling; wordt met de definitie opgeslagen maar nog niet afgedwongen in de UI (standaard: true)
Tot 50 eigenschappen per agent. Eigenschappen kunnen via slepen-en-neerzetten worden herordend in de instellingen-UI.

Doorgeven vanuit de widget#

Geef eigenschapswaarden door in het veld properties van Respondo.identify(). De keys moeten overeenkomen met de eigenschapsdefinities uit de Agentinstellingen.

Widget-integratiejavascript
Respondo.identify({
  email: 'user@example.com',
  name: 'Jane Smith',
  userId: 'usr_456',
  properties: {
    account_type: 'enterprise',   // enum
    region: 'eu-west',            // string
    monthly_spend: '15000',       // number (doorgegeven als string)
    is_partner: 'true',           // boolean (doorgegeven als string)
    contract_end: '2026-12-31',   // date
    dashboard_url: 'https://app.example.com/org/123'  // url
  }
});
Alle eigenschapswaarden worden als strings doorgegeven. Het dashboard verzorgt de typespecifieke weergave (bijv. boolean → Ja/Nee, url → klikbare link, enum → badge).

Integratiesnippet#

Het Integratiesnippet verschijnt automatisch onder Agentinstellingen → Contacteigenschappen zodra je minstens één eigenschap hebt gedefinieerd, met al je eigenschap-keys vooraf ingevuld. Klik op Kopiëren om het over te nemen en plak het in je applicatie. Het gegenereerde snippet bevat ook een userHash-placeholder voor identiteitsverificatie (HMAC-SHA256).

Hoe waarden worden opgeslagen#

Eigenschapswaarden worden opgeslagen in het metadata JSONB-veld van het gesprek met een cp_-prefix. Bijvoorbeeld: een eigenschap met key account_type wordt opgeslagen als cp_account_type.

Eigenschappen worden bij elk bericht bijgewerkt — als de widget nieuwe waarden verstuurt, overschrijven ze de bestaande. Dit betekent dat eigenschapswaarden altijd de meest recente data uit je applicatie weerspiegelen.

Filteren in de Inbox#

Filter gesprekken op eigenschapswaarden via de filterbalk van de Inbox of een opgeslagen weergave. Voeg een voorwaarde Eigenschap toe, kies de eigenschap op naam — de kiezer toont elke definitie van al je agents en accepteert ook een ruwe key zonder definitie — en kies vervolgens een waarde. Het waardeveld stelt tijdens het typen waargenomen waarden en eventuele enum-waarden voor.

Via de API accepteren de lijst-endpoints voor gesprekken een cp.<key>=<value> queryparameter (een exacte alias van attr.<key>). Er is geen vrije-tekst querysyntaxis:

GET /api/v1/conversations?cp.account_type=enterprise

Waarden bewerken#

Eigenschapswaarden worden ingesteld door je applicatie — via de widgetintegratie of de API — en zijn alleen-lezen in het gespreksdetailpaneel. Het paneel linkt naar het profiel van het contact, waar medewerkers de attributen van het contact kunnen bekijken en bewerken (Contacten → contact → Attributen).

Eigenschappen vs. metadata

Kenmerkpropertiesmetadata
SchemaGedefinieerd in Agentinstellingen met typesVrije key-value-paren
FilterbaarJa, via de filterbalk / opgeslagen weergaven (API: cp.<key>-parameter)Nee
Bewerkbaar door medewerkersNee — waarden komen uit je applicatie; contactattributen worden bewerkt op het contactprofielNee
Getypeerde weergaveJa (badges, links, datums, booleans)Alleen platte tekst
AutocompleteJa, waardesuggesties in het waardeveld van het filterNee
Gebruik metadata voor ad-hocvelden die geen filtering of getypeerde weergave nodig hebben. Gebruik properties voor gestructureerde data die je team actief zal gebruiken voor segmentatie en workflow.