front.contact.get

Element details

type: meya.front.component.contact.get
class: FrontContactGetComponent
path: /meya/front/component/contact/get.py
signature: -

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
integrationA string identifier for the Front integration (e.g. integration.front)FrontIntegrationRef
handleA human readable alias for the Front contact. The format is alt:: (e.g. alt☎️+12345678900)nullstr
sourceFront 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
contextSend context data with this component's event.{}
dict
sensitivetruebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
contact_idFront Contact IDnullstr

Usage reference

Basic

triggers:
  - keyword: meya.front.component.contact.get
steps:
  - type: meya.front.component.contact.get
    integration: integration.front

Full

triggers:
  - keyword: meya.front.component.contact.get
steps:
  - type: meya.front.component.contact.get
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    integration: integration.front
    handle: STRING
    source: email|phone|twitter|facebook|intercom|front_chat|custom
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    contact_id: STRING