orb

type: meya.orb.integration
class: OrbIntegration
path: /meya/orb/integration/integration.py
signature: -

Fields

field

signature

required

type

default

description               

spec

Spec

null

Override the original spec for this element

enabled

bool

true

Enables the integration, allowing it to process events and HTTP entries

filter

IntegrationFilter

rx_sub: true
rx: true
tx: "\nNOT (\n meya.http.event.webhook\n OR meya.csp.event.event\n OR meya.orb.event.device\n
\ OR meya.orb.event.device.connect\n OR meya.orb.event.device.heartbeat\n
\ OR meya.orb.event.device.state\n)\n"
tx_pub: true

This allows you to use GridQL to filter incoming and outgoing entries. This can be useful if you would like the Orb integration not to process a specific event, for example typing indicators or heartbeats.

verify_token

str

null

max_attachment_size

int

null

Controls maximum attachment size supported by the integration in bytes

markdown

list
bool

false

typing

bool

true

When set to 'False', all typing indicators received by the integration will be ignored.

theme

OrbThemeElementSpec

brand_color:
bot_avatar_monogram:
bot_avatar_url:

Allows you to set the Orb's theme properties such as the brand color, etc.

composer

OrbComposerElementSpec

focus:
placeholder:
collapse_placeholder:
visibility:
placeholder_text:
collapse_placeholder_text:
file_button_text:
file_send_text:
image_button_text:
camera_button_text:
gallery_button_text:

Allows you to set the Orb's composer properties such as placeholder, text, etc.

header

OrbHeaderElementSpec

buttons:
title:
progress:
milestones:
extra_buttons:

Allows you to set the Orb's header properties such buttons, title, etc.

menu

OrbMenuElementSpec

close_text:
back_text:

Allows you to set the Orb's menu properties such as close display text.

drop

OrbDropElementSpec

drag_and_drop_text:

Allows you to set the Orb's drag and drop properties such as the drag and drop display text.

splash

OrbSplashElementSpec

ready_text:

Allows you to the set the Orb Mobile SDK's splash screen properties. Note that this property is not fully observed yet, but will be in the future.

launcher

OrbLauncherElementSpec

type:
icon:
text:

Allows you to set the Orb's launcher properties such as the launcher type, text etc. Note that this is only applicable for the Orb Web SDK and not the Orb Mobile SDK.

media_upload

OrbMediaUploadElementSpec

all:
file:
image:

Allows you to configure which media types are enabled for upload. If a specific type is not specified, the all value is used.

container

str

null

The HTML container to mount the Orb in e.g. document.querySelector("#orb-mount"). Note that this is only applicable for the Orb Web SDK and not the Orb Mobile SDK.

session_expiry

timedelta

"4w 2d"

The amount time until an Orb session expires. When the user connects after the session has expired, a new session will be created and the old session token will no longer be valid.

collect

OrbCollectConfig

language: user
ip_address: event
location:
referrer: event
url: event
context: event

The Orb integration collects a number data points, e.g. ip address, when a user connects. This property allows you to configure in which data scope (event|thread|user) each data point should be stored.

identity_verification

bool

true

Verify the identity of every Orb user. If disabled, the Orb user ID becomes self-authenticating, so it is recommended to use secure random user IDs (e.g. salted hash of app user ID or email).

Examples

Basic

type: meya.orb.integration

Full

type: meya.orb.integration
spec:
  type: STRING
  data:
    STRING: ANY
  timeout: 123
  trigger_when: ANY
enabled: false
filter:
  rx_sub: STRING
  rx: STRING
  tx: STRING
  tx_pub: STRING
verify_token: STRING
max_attachment_size: 123
markdown:
  - format|linkify|breaks|typographer
typing: false
theme:
  brand_color: STRING
  bot_avatar_monogram: STRING
  bot_avatar_url: STRING
composer:
  focus: file|image|text|blur
  placeholder: STRING
  collapse_placeholder: STRING
  visibility: collapse|hide|show
  placeholder_text: STRING
  collapse_placeholder_text: STRING
  file_button_text: STRING
  file_send_text: STRING
  image_button_text: STRING
  camera_button_text: STRING
  gallery_button_text: STRING
header:
  buttons:
    - url: STRING
      javascript: STRING
      button_id: STRING
      context:
        STRING: ANY
      default: false
      disabled: false
      divider: false
      icon:
        url: STRING
        color: STRING
        path: STRING
      action: COMPONENT
      value: ANY
      result: ANY
      data:
        STRING: ANY
      magic: false
      type: text|url|static|menu|divider|action|flow_next|component_next
      menu:
        - BUTTONELEMENTSPEC
      text: STRING
  title:
    text: STRING
    icon:
      url: STRING
      color: STRING
      path: STRING
  progress:
    value: 123
    show_percent: false
  milestones:
    - text: STRING
      current: false
  extra_buttons:
    - url: STRING
      javascript: STRING
      button_id: STRING
      context:
        STRING: ANY
      default: false
      disabled: false
      divider: false
      icon:
        url: STRING
        color: STRING
        path: STRING
      action: COMPONENT
      value: ANY
      result: ANY
      data:
        STRING: ANY
      magic: false
      type: text|url|static|menu|divider|action|flow_next|component_next
      menu:
        - BUTTONELEMENTSPEC
      text: STRING
menu:
  close_text: STRING
  back_text: STRING
drop:
  drag_and_drop_text: STRING
splash:
  ready_text: STRING
launcher:
  type: orb|message|hide
  icon: STRING
  text: STRING
media_upload:
  all: false
  file: false
  image: false
container: STRING
session_expiry: 60s
collect:
  language: user|user_overwrite|thread|thread_overwrite|event
  ip_address: user|user_overwrite|thread|thread_overwrite|event
  location: user|user_overwrite|thread|thread_overwrite|event
  referrer: user|user_overwrite|thread|thread_overwrite|event
  url: user|user_overwrite|thread|thread_overwrite|event
  context: user|user_overwrite|thread|thread_overwrite|event
identity_verification: false