freshworks.freshchat

type: meya.freshworks.freshchat.integration
class: FreshchatIntegration
path: /meya/freshworks/freshchat/integration/integration.py
signature: -

Fields

field

signature

required

type

default

description               

spec

ForwardRef('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: "\nmeya.event.entry.interactive\nOR meya.csp.event\nOR meya.button.event.click\n
OR meya.form.event.submit\n"
tx_pub: true

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.

avatar

CspIntegrationAvatar

crop: circle

agent_command_prefix

str

"~"

transcript

CspIntegrationTranscript

count: 25
user_prefix: user
bot_prefix: bot
agent_prefix: agent
note_prefix: 📝

agent

AgentSpec

name:
avatar:

api_token

str

app_id

str

bot_agent_email

str

api_root

str

"https://api.freshchat.com"

channel_name

str

"Inbox"

channel_tags

list

null

note_indicator

str

"📝"

assignment_rules

FreshchatAssignmentRules

no_assignee: bot
human_agent: agent
bot_agent: bot
group: agent

user_source_property_name

str

"source"

user_source_property_value

str

"meya"

Examples

Basic

type: meya.freshworks.freshchat.integration
api_token: STRING
app_id: STRING
bot_agent_email: STRING

Full

type: meya.freshworks.freshchat.integration
spec: '?'
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
avatar:
  crop: circle|square
agent_command_prefix: STRING
transcript:
  count: 123
  user_prefix: STRING
  bot_prefix: STRING
  agent_prefix: STRING
  note_prefix: STRING
agent:
  name: full|first|first_initial|first_last_initial|first_initial_last_initial
  avatar:
    image: STRING
    crop: circle|square
    monogram: full|first|first_initial|first_last_initial|first_initial_last_initial
api_token: STRING
app_id: STRING
bot_agent_email: STRING
api_root: STRING
channel_name: STRING
channel_tags:
  - STRING
note_indicator: STRING
assignment_rules:
  no_assignee: STRING
  human_agent: STRING
  bot_agent: STRING
  group: STRING
user_source_property_name: STRING
user_source_property_value: STRING