form.ask

type: meya.form.event.ask
class: FormAskEvent
path: /meya/form/event/ask.py
signature: -

Fields

field

signature

required

type

default

description               

parent_entry_ref

EntryRef

null

trace_id

str

"-"

sensitive

bool

false

user_id

str

thread_id

str

integration_id

str

context

dict

{}

composer

ComposerEventSpec

quick_replies

list

markdown

list

form_id

str

fields

list

text

str

null

Examples

Data

{
    "type": "meya.form.event.ask", 
    "data": {
        "parent_entry_ref": {
            "ledger": "STRING", 
            "id": "STRING", 
            "data": {
                "STRING": "STRING"
            }
        }, 
        "trace_id": "STRING", 
        "sensitive": false, 
        "user_id": "STRING", 
        "thread_id": "STRING", 
        "integration_id": "STRING", 
        "context": {
            "STRING": "ANY"
        }, 
        "composer": {
            "focus": "file|image|text|blur", 
            "placeholder": "STRING", 
            "visibility": "collapse|hide|show"
        }, 
        "quick_replies": [
            {
                "url": "STRING", 
                "javascript": "STRING", 
                "button_id": "STRING", 
                "context": {
                    "STRING": "ANY"
                }, 
                "text": "STRING", 
                "icon": {
                    "url": "STRING", 
                    "color": "STRING"
                }
            }
        ], 
        "markdown": [
            "format|linkify|breaks|typographer"
        ], 
        "form_id": "STRING", 
        "fields": [
            {
                "name": "STRING", 
                "autocomplete": "STRING", 
                "icon": {
                    "url": "STRING", 
                    "color": "STRING"
                }, 
                "label": "STRING", 
                "no_results_text": "STRING", 
                "placeholder": "STRING", 
                "required": false, 
                "type": "email|text|select", 
                "custom": false, 
                "search": false, 
                "multi": false, 
                "options": [
                    {
                        "text": "STRING", 
                        "disabled": false
                    }
                ], 
                "default": "ANY"
            }
        ], 
        "text": "STRING"
    }
}