orb.magic_link

Element details

type: meya.orb.component.magic_link
class: OrbMagicLinkComponent
path: /meya/orb/component/magic_link.py
signature: magic_link

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
contextSend context data with this component's event.{}
dict
sensitiveMark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled.falsebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
magic_linkstr
integrationOrbIntegrationRef
integration_user_idnullstr
integration_thread_idnullstr
button_idstr
bool
single_usebool
expiry"1d"timedelta

Usage reference

Basic

triggers:
  - keyword: meya.orb.component.magic_link
steps:
  - magic_link: STRING
    integration: integration.orb
    button_id: STRING
    single_use: false

Full

triggers:
  - keyword: meya.orb.component.magic_link
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
    magic_link: STRING
    integration: integration.orb
    integration_user_id: STRING
    integration_thread_id: STRING
    button_id: STRING
    single_use: false
    expiry: 60s