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

Fields

field	signature	required	type	default	description
spec	○	○	Spec	null	Override the original spec for this element
integration	○	◉	FrontIntegrationRef		A string identifier for the Front integration (e.g. integration.front)
attachments_url	○	○	list	[]	A list of file URLs to attach to the conversation
text	○	○	str	null	The plain text version of the message
html	○	○	str	null	The HTML version of the message
context	○	○	dict	{}	Send context data with this component's event
sensitive	○	○	bool	true
triggers	○	○	list	[]	Activate these dynamic triggers when the component runs
thread_ref	○	○	str	null	A way of uniquely identifying the Meya thread the conversation is associated with. Defaults to meya_thread/
contact_handle	○	○	str	null	An alias for the Front Contact. The format is alt:: (e.g. alt+12345678900). Defaults to meya_user/
contact_source	○	○	FrontSource	"custom"	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.
contact_id	○	○	str	null	Front Contact ID
subject	○	○	str	null	The subject of the message
send_transcript	○	○	bool	true	Whether or not the chat transcript should be included in the conversation. Useful for providing context for agents
assignee_id	○	○	str		The Front ID of the teammate to assign the conversation to. Set it to null to unassign. Teammate IDs have the format tea_xxxx
assignee_email	○	○	str		The email of the teammate to assign the conversation to. Set it to null to unassign.
inbox_id	○	○	str	null	The Front ID of the inbox to move the conversation to. Inbox IDs have the format inb_xxxxx
status	○	○	str	null	The new status of the conversation
tag_ids	○	○	list	null	A list of Front tag IDs. Tag IDs have the format tag_xxxxxx
link	○	○	bool	true	Link the current Meya thread to this integration thread

Examples

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