front.conversation.update

Element details

type: meya.front.component.conversation.update
class: FrontConversationUpdateComponent
path: /meya/front/component/conversation/update.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

conversation_id

The Front conversation ID. Conversation IDs have the format cnv_xxxxxxxx

null

str

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

Usage reference

Basic

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

Full

triggers:
  - keyword: meya.front.component.conversation.update
steps:
  - type: meya.front.component.conversation.update
    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
    conversation_id: STRING
    assignee_id: STRING
    assignee_email: STRING
    inbox_id: STRING
    status: STRING
    tag_ids:
      - STRING