front.conversation.create

Element details

type: meya.front.component.conversation.create
class: FrontConversationCreateComponent
path: /meya/front/component/conversation/create.py
signature: -

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
integrationA string identifier for the Front integration (e.g. integration.front)FrontIntegrationRef
attachments_urlA list of file URLs to attach to the conversation[]list
textThe plain text version of the messagenullstr
htmlThe HTML version of the messagenullstr
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
thread_refA way of uniquely identifying the Meya thread the conversation is associated with. Defaults to meya_thread/nullstr
contact_handleAn alias for the Front Contact. The format is alt:: (e.g. alt☎️+12345678900). Defaults to meya_user/nullstr
contact_sourceFront contact source. e.g. email. Front enforces contact handle format depending on the contact source, e.g., for twitter the contact handle must start with @.This value will only be used in case of contact creation."custom"FrontSource
contact_idFront Contact IDnullstr
subjectThe subject of the messagenullstr
send_transcriptWhether or not the chat transcript should be included in the conversation. Useful for providing context for agentstruebool
assignee_idThe Front ID of the teammate to assign the conversation to. Set it to null to unassign. Teammate IDs have the format tea_xxxxstr
assignee_emailThe email of the teammate to assign the conversation to. Set it to null to unassign.str
inbox_idThe Front ID of the inbox to move the conversation to. Inbox IDs have the format inb_xxxxxnullstr
statusThe new status of the conversationnullstr
tag_idsA list of Front tag IDs. Tag IDs have the format tag_xxxxxxnulllist
linkLink the current Meya thread to this integration threadtruebool

Usage reference

Basic

triggers:
  - keyword: meya.front.component.conversation.create
steps:
  - type: meya.front.component.conversation.create
    integration: integration.front
    assignee_id: STRING
    assignee_email: STRING

Full

triggers:
  - keyword: meya.front.component.conversation.create
steps:
  - type: meya.front.component.conversation.create
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    integration: integration.front
    attachments_url:
      - STRING
    text: STRING
    html: STRING
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    thread_ref: STRING
    contact_handle: STRING
    contact_source: email|phone|twitter|facebook|intercom|front_chat|custom
    contact_id: STRING
    subject: STRING
    send_transcript: false
    assignee_id: STRING
    assignee_email: STRING
    inbox_id: STRING
    status: STRING
    tag_ids:
      - STRING
    link: false