front.contact.create

Element details

type: meya.front.component.contact.create
class: FrontContactCreateComponent
path: /meya/front/component/contact/create.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
namenullstr
descriptionA description of the contactnullstr
avatar_urlThe URL of an image to use as the contact's avatarnullstr
group_namesList of all the group names the contact belongs to. Missing groups will be created automatically.nulllist
is_spammerIndicates whether or not the contact is marked as a spammernullbool
linksA list of all the links of the contactnulllist
custom_fieldsCustom field attributes for this contact. Leave empty if you do not wish to update the attributes. Not sending existing attributes will automatically remove them.{}
dict
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
linkLink the current Meya user to this integration usertruebool

Usage reference

Basic

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

Full

triggers:
  - keyword: meya.front.component.contact.create
steps:
  - type: meya.front.component.contact.create
    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
    name: STRING
    description: STRING
    avatar_url: STRING
    group_names:
      - STRING
    is_spammer: false
    links:
      - STRING
    custom_fields:
      STRING: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    link: false