type: meya.front.component.contact.create
class: FrontContactCreateComponent
path: /meya/front/component/contact/create.py
signature: -

Fields

field	signature	required	type	default	description
spec	○	○	ForwardRef('Spec')	null	Override the original spec for this element
integration	○	◉	FrontIntegrationRef		A string identifier for the Front integration (e.g. integration.front)
handle	○	○	str	null	A human readable alias for the Front contact. The format is alt:: (e.g. alt+12345678900)
source	○	○	FrontSource	"custom"	Front 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.
name	○	○	str	null
description	○	○	str	null	A description of the contact
avatar_url	○	○	str	null	The URL of an image to use as the contact's avatar
group_names	○	○	list	null	List of all the group names the contact belongs to. Missing groups will be created automatically.
is_spammer	○	○	bool	null	Indicates whether or not the contact is marked as a spammer
links	○	○	list	null	A list of all the links of the contact
custom_fields	○	○	dict	{}	Custom field attributes for this contact. Leave empty if you do not wish to update the attributes. Not sending existing attributes will automatically remove them.
context	○	○	dict	{}	Send context data with this component's event
sensitive	○	○	bool	true
triggers	○	○	list	[]	Activate these dynamic triggers when the component runs
link	○	○	bool	true	Link the current Meya user to this integration user

Examples

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: '?'
    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