Element details

type: meya.front.component.message.send
class: FrontMessageSendComponent
path: /meya/front/component/message/send.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
integration	A string identifier for the Front integration (e.g. integration.front)	◉	○		FrontIntegrationRef
attachments_url	A list of file URLs to attach to the conversation	○	○	[]	list
text	The plain text version of the message	○	○	null	str
html	The HTML version of the message	○	○	null	str
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
thread_ref	A way of uniquely identifying the Meya thread the conversation is associated with. Defaults to meya_thread/`<Meya thread ID>`	○	○	null	str
conversation_id	The Front conversation ID. Conversation IDs have the format cnv_xxxxxxxx	○	○	null	str
contact_handle	An alias for the Front Contact. The format is alt:`<source>`:`<handle>` (e.g. alt:phone:+12345678900). Defaults to meya_user/`<Meya user ID>`	○	○	null	str
contact_id	The Front Contact ID	○	○	null	str
subject	The subject of the message	○	○	null	str
send_transcript	Send the chat transcript to be included in the conversation. Useful for providing context for agents.	○	○	false	bool

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