front.message.send

Element details

type: meya.front.component.message.send
class: FrontMessageSendComponent
path: /meya/front/component/message/send.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
conversation_idThe Front conversation ID. Conversation IDs have the format cnv_xxxxxxxxnullstr
contact_handleAn alias for the Front Contact. The format is alt:: (e.g. alt☎️+12345678900). Defaults to meya_user/nullstr
contact_idThe Front Contact IDnullstr
subjectThe subject of the messagenullstr
send_transcriptSend the chat transcript to be included in the conversation. Useful for providing context for agents.falsebool

Usage reference

Basic

triggers:
  - keyword: meya.front.component.message.send
steps:
  - type: meya.front.component.message.send
    integration: integration.front

Full

triggers:
  - keyword: meya.front.component.message.send
steps:
  - type: meya.front.component.message.send
    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
    conversation_id: STRING
    contact_handle: STRING
    contact_id: STRING
    subject: STRING
    send_transcript: false