Element details

type: meya.csp.component.note
class: NoteComponent
path: /meya/csp/component/note.py
signature: note

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
context	Send context data with this component's event.	○	○	{}	dict
sensitive	Mark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled.	○	○	false	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
note	Leave a note in the transcript for customer support agents. These notes will not be sent to the end user and will only be visible to the agent. Each customer support integration will display bot notes in a different way, please see the integration documentation for specific details.	◉	◉		str

Usage reference

Basic

triggers:
  - keyword: meya.csp.component.note
steps:
  - note: STRING

Full

triggers:
  - keyword: meya.csp.component.note
steps:
  - spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    note: STRING