front.contact.handle.delete

type: meya.front.component.contact.handle.delete
class: FrontContactHandleDeleteComponent
path: /meya/front/component/contact/handle/delete.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

A human readable alias for the Front contact. The format is alt:: (e.g. alt:phone:+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.

contact_id

str

null

The Front Contact ID

context

dict

{}

Send context data with this component's event

sensitive

bool

true

triggers

list

[]

Activate these dynamic triggers when the component runs

force

bool

false

Setting force to true will delete the contact if the handle to delete is the last one of the contact

Examples

Basic

triggers:
  - keyword: meya.front.component.contact.handle.delete
steps:
  - type: meya.front.component.contact.handle.delete
    integration: integration.front
    handle: STRING

Full

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