zendesk.chat.session.start

Element details

type: meya.zendesk.chat.component.session.start
class: ZendeskChatSessionStartComponent
path: /meya/zendesk/chat/component/session/start.py
signature: -

Fields

field

description

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

required

signature

default

type

spec

Override the original spec for this element.

null

Spec

context

Send context data with this component's event.

{}

dict

sensitive

true

bool

triggers

Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.

[]

list

integration

ZendeskChatIntegrationRef

visitor_name

null

str

visitor_email

null

str

visitor_phone

null

str

visitor_url

null

str

visitor_user_agent

null

str

visitor_referrer

null

str

tags

null

list

department

null

str

Usage reference

Basic

triggers:
  - keyword: meya.zendesk.chat.component.session.start
steps:
  - type: meya.zendesk.chat.component.session.start
    integration: integration.zendesk_chat

Full

triggers:
  - keyword: meya.zendesk.chat.component.session.start
steps:
  - type: meya.zendesk.chat.component.session.start
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    integration: integration.zendesk_chat
    visitor_name: STRING
    visitor_email: STRING
    visitor_phone: STRING
    visitor_url: STRING
    visitor_user_agent: STRING
    visitor_referrer: STRING
    tags:
      - STRING
    department: STRING