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

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
contextSend context data with this component's event.{}
dict
sensitivetruebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
integrationZendeskChatIntegrationRef
visitor_namenullstr
visitor_emailnullstr
visitor_phonenullstr
visitor_urlnullstr
visitor_user_agentnullstr
visitor_referrernullstr
tagsnulllist
departmentnullstr

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