zendesk.chat.session.start

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

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

context

dict

{}

Send context data with this component's event

sensitive

bool

true

triggers

list

[]

Activate these dynamic triggers when the component runs

integration

ZendeskChatIntegrationRef

visitor_name

str

null

visitor_email

str

null

visitor_phone

str

null

visitor_url

str

null

visitor_user_agent

str

null

visitor_referrer

str

null

tags

list

null

department

str

null

Examples

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: '?'
    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