> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corti.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# embedded.interactionOptionsSet

> Emitted when the embedded setInteractionOptions method is successfully called.

## Event Properties

| Field          | Value                              |
| -------------- | ---------------------------------- |
| `event`        | `"embedded.interactionOptionsSet"` |
| `confidential` | `boolean`                          |
| `payload`      | `object`                           |

<Tabs>
  <Tab title="Public Payload">
    | Field            | Type                                                                                                                                                                                                                                                                                                                                        | Description                                         |
    | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
    | `mode`           | `{ fallback: "virtual" \| "in-person"; options: ("virtual" \| "in-person")[]; } \| null \| undefined`                                                                                                                                                                                                                                       | Allowed interaction modes and fallback selection    |
    | `spokenLanguage` | `{ fallback: string; } \| null \| undefined`                                                                                                                                                                                                                                                                                                | Spoken language fallback to apply                   |
    | `templates`      | `{ sources?: { personal?: { enabled: boolean \| null; } \| undefined; standard: { enabled: boolean \| null; include: { regions: string[] \| null; families: string[] \| null; }; }; project: { enabled: boolean \| null; include: { ...; }; exclude: { ...; }; }; } \| undefined; defaultTemplate?: { ...; } \| ... 1 more ... \| undef...` | Template options applied by the embedded API        |
    | `documents`      | `{ actions?: { sync?: boolean \| null \| undefined; } \| undefined; allowedLanguages: string[] \| null; } \| undefined`                                                                                                                                                                                                                     | Document action options applied by the embedded API |

    <Accordion title="mode object properties">
      | Field      | Type     | Description |
      | ---------- | -------- | ----------- |
      | `fallback` | `string` | -           |
      | `options`  | `array`  | -           |
    </Accordion>

    <Accordion title="spokenLanguage object properties">
      | Field      | Type     | Description |
      | ---------- | -------- | ----------- |
      | `fallback` | `string` | -           |
    </Accordion>

    <Accordion title="templates object properties">
      | Field             | Type     | Description |
      | ----------------- | -------- | ----------- |
      | `sources`         | `object` | -           |
      | `defaultTemplate` | `object` | -           |
    </Accordion>

    <Accordion title="documents object properties">
      | Field              | Type     | Description |
      | ------------------ | -------- | ----------- |
      | `actions`          | `object` | -           |
      | `allowedLanguages` | `array`  | -           |
    </Accordion>

    #### Example

    ```json theme={null}
    {
      "event": "embedded.interactionOptionsSet",
      "confidential": false,
      "payload": {
        "mode": {
          "fallback": "virtual",
          "options": [
            "virtual",
            "in-person"
          ]
        },
        "spokenLanguage": {
          "fallback": "en"
        },
        "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"
            }
          }
        },
        "documents": {
          "actions": {
            "sync": true
          },
          "allowedLanguages": [
            "nl",
            "fr",
            "de-CHE"
          ]
        }
      }
    }
    ```
  </Tab>

  <Tab title="Confidential Payload">
    | Field            | Type                                                                                                                                                                                                                                                                                                                                        | Description                                         |
    | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
    | `mode`           | `{ fallback: "virtual" \| "in-person"; options: ("virtual" \| "in-person")[]; } \| null \| undefined`                                                                                                                                                                                                                                       | Allowed interaction modes and fallback selection    |
    | `spokenLanguage` | `{ fallback: string; } \| null \| undefined`                                                                                                                                                                                                                                                                                                | Spoken language fallback to apply                   |
    | `templates`      | `{ sources?: { personal?: { enabled: boolean \| null; } \| undefined; standard: { enabled: boolean \| null; include: { regions: string[] \| null; families: string[] \| null; }; }; project: { enabled: boolean \| null; include: { ...; }; exclude: { ...; }; }; } \| undefined; defaultTemplate?: { ...; } \| ... 1 more ... \| undef...` | Template options applied by the embedded API        |
    | `documents`      | `{ actions?: { sync?: boolean \| null \| undefined; } \| undefined; allowedLanguages: string[] \| null; } \| undefined`                                                                                                                                                                                                                     | Document action options applied by the embedded API |

    <Accordion title="mode object properties">
      | Field      | Type     | Description |
      | ---------- | -------- | ----------- |
      | `fallback` | `string` | -           |
      | `options`  | `array`  | -           |
    </Accordion>

    <Accordion title="spokenLanguage object properties">
      | Field      | Type     | Description |
      | ---------- | -------- | ----------- |
      | `fallback` | `string` | -           |
    </Accordion>

    <Accordion title="templates object properties">
      | Field             | Type     | Description |
      | ----------------- | -------- | ----------- |
      | `sources`         | `object` | -           |
      | `defaultTemplate` | `object` | -           |
    </Accordion>

    <Accordion title="documents object properties">
      | Field              | Type     | Description |
      | ------------------ | -------- | ----------- |
      | `actions`          | `object` | -           |
      | `allowedLanguages` | `array`  | -           |
    </Accordion>

    #### Example

    ```json theme={null}
    {
      "event": "embedded.interactionOptionsSet",
      "confidential": true,
      "payload": {
        "mode": {
          "fallback": "virtual",
          "options": [
            "virtual",
            "in-person"
          ]
        },
        "spokenLanguage": {
          "fallback": "en"
        },
        "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"
            }
          }
        },
        "documents": {
          "actions": {
            "sync": true
          },
          "allowedLanguages": [
            "nl",
            "fr",
            "de-CHE"
          ]
        }
      }
    }
    ```
  </Tab>
</Tabs>