Skip to main content

​
Event Properties

FieldValue
event"embedded.interactionOptionsSet"
confidentialboolean
payloadobject
FieldTypeDescription
mode{ fallback?: "virtual" | "in-person" | null | undefined; options?: ("virtual" | "in-person")[] | null | undefined; } | null | undefinedAllowed interaction modes and fallback selection
spokenLanguage{ fallback?: string | null | undefined; options?: string[] | null | undefined; } | null | undefinedSpoken language fallback to apply
templates{ sources?: { personal?: { enabled?: boolean | null | undefined; } | undefined; standard?: { enabled?: boolean | null | undefined; include?: { regions?: string[] | null | undefined; families?: string[] | ... 1 more ... | undefined; } | undefined; } | undefined; project?: { ...; } | undefined; } | undefined; defaultT...Template options applied by the embedded API
documents{ actions?: { sync?: boolean | null | undefined; } | undefined; allowedLanguages?: string[] | null | undefined; maxGenerated?: number | "unlimited" | null | undefined; } | undefinedDocument action options applied by the embedded API
FieldTypeDescription
fallbackstring-
optionsarray-
FieldTypeDescription
fallbackstring-
optionsarray-
FieldTypeDescription
sourcesobject-
defaultTemplateobject-
FieldTypeDescription
actionsobject-
allowedLanguagesarray-
maxGeneratednumber-

​
Example

{
  "event": "embedded.interactionOptionsSet",
  "confidential": false,
  "payload": {
    "mode": {
      "fallback": "virtual",
      "options": [
        "virtual",
        "in-person"
      ]
    },
    "spokenLanguage": {
      "fallback": "en",
      "options": [
        "en",
        "de"
      ]
    },
    "templates": {
      "sources": {
        "personal": {
          "enabled": true
        },
        "standard": {
          "enabled": true,
          "include": {
            "regions": [
              "BE"
            ],
            "families": [
              "soap"
            ]
          }
        },
        "project": {
          "enabled": true,
          "include": {
            "ids": [
              "7a0ab5b8-1f62-4f75-86a7-4fcd8fd07b5d"
            ]
          },
          "exclude": {
            "ids": [
              "d7a7fd8c-8892-4475-81d3-3414b7d8e27d"
            ]
          }
        }
      },
      "defaultTemplate": {
        "behaviour": "fallback",
        "template": {
          "source": "standard",
          "id": "soap"
        },
        "allowUserSelection": false
      }
    },
    "documents": {
      "actions": {
        "sync": true
      },
      "allowedLanguages": [
        "nl",
        "fr",
        "de-CHE"
      ],
      "maxGenerated": 2
    }
  }
}