Element details

type: meya.front.component.conversation.create
class: FrontConversationCreateComponent
path: /meya/front/component/conversation/create.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
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_source	Front 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_id	Front Contact ID	○	○	null	str
subject	The subject of the message	○	○	null	str
send_transcript	Whether or not the chat transcript should be included in the conversation. Useful for providing context for agents	○	○	true	bool
assignee_id	The Front ID of the teammate to assign the conversation to. Set it to null to unassign. Teammate IDs have the format tea_xxxx	○	○		str
assignee_email	The email of the teammate to assign the conversation to. Set it to null to unassign.	○	○		str
inbox_id	The Front ID of the inbox to move the conversation to. Inbox IDs have the format inb_xxxxx	○	○	null	str
status	The new status of the conversation	○	○	null	str
tag_ids	A list of Front tag IDs. Tag IDs have the format tag_xxxxxx	○	○	null	list
link	Link the current Meya thread to this integration thread	○	○	true	bool

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