Element details
type: meya.calendly.component
class: CalendlyComponent
path: /meya/calendly/component/component.py
signature: calendly
Fields
field | description | required | signature | default | type |
---|---|---|---|---|---|
spec | Override the original spec for this element. | ○ | ○ | null | Spec |
context | Send context data with this component's event. | ○ | ○ | {} | dict |
sensitive | Mark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled. | ○ | ○ | false | bool |
triggers | Activate these dynamic triggers when the component runs. Check the component triggers guide for more info. | ○ | ○ | [] | list |
quick_replies | List of buttons that the user can select for replies. | ○ | ○ | [] | list |
composer | ○ | ○ | focus: blur placeholder: collapse_placeholder: visibility: character_limit: | ComposerElementSpec | |
header | Override the header for this component. | ○ | ○ | buttons: title: progress: milestones: extra_buttons: | HeaderElementSpec |
markdown | Override the bot Markdown mode for this component. Check the Markdown guide for more info. | ○ | ○ | null | list bool NoneType |
calendly | ◉ | ◉ | str | ||
integration | The Calendly integration to use for booking confirmation | ○ | ○ | null | CalendlyIntegrationRef |
button_text | ○ | ○ | "Book a meeting" | str | |
closed_text | ○ | ○ | "No longer interested in booking a meeting?" | str | |
pending_text | ○ | ○ | "Completing the booking..." | str | |
try_again_text | ○ | ○ | "I'm still interested" | str | |
cancel_text | ○ | ○ | "Not interested" | str | |
prefill | ○ | ○ | null | dict | |
utm_source | ○ | ○ | "meya" | str | |
utm_campaign | ○ | ○ | null | str | |
utm_medium | ○ | ○ | null | str | |
utm_term | ○ | ○ | null | str | |
ask | ○ | ○ | null | str | |
title | ○ | ○ | null | str | |
description | ○ | ○ | null | str | |
image | ○ | ○ | null | TileImage | |
rows | ○ | ○ | [] | list | |
button_style | ○ | ○ | null | TileButtonStyle | |
Usage reference
Basic
triggers:
- keyword: meya.calendly.component
steps:
- calendly: STRING
Full
triggers:
- keyword: meya.calendly.component
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
quick_replies:
- url: STRING
javascript: STRING
button_id: STRING
context:
STRING: ANY
default: false
disabled: false
divider: false
icon:
url: STRING
color: STRING
path: STRING
action: COMPONENT
value: ANY
result: ANY
data:
STRING: ANY
magic: false
type: text|url|static|menu|divider|action|flow_next|component_next
menu:
- BUTTONELEMENTSPEC
text: STRING
composer:
focus: file|image|text|blur
placeholder: STRING
collapse_placeholder: STRING
visibility: collapse|hide|show
character_limit:
length: 123
error_text: STRING
header:
buttons:
- url: STRING
javascript: STRING
button_id: STRING
context:
STRING: ANY
default: false
disabled: false
divider: false
icon:
url: STRING
color: STRING
path: STRING
action: COMPONENT
value: ANY
result: ANY
data:
STRING: ANY
magic: false
type: text|url|static|menu|divider|action|flow_next|component_next
menu:
- BUTTONELEMENTSPEC
text: STRING
title:
text: STRING
icon:
url: STRING
color: STRING
path: STRING
progress:
value: 123
show_percent: false
milestones:
- text: STRING
current: false
extra_buttons:
- url: STRING
javascript: STRING
button_id: STRING
context:
STRING: ANY
default: false
disabled: false
divider: false
icon:
url: STRING
color: STRING
path: STRING
action: COMPONENT
value: ANY
result: ANY
data:
STRING: ANY
magic: false
type: text|url|static|menu|divider|action|flow_next|component_next
menu:
- BUTTONELEMENTSPEC
text: STRING
markdown:
- format|linkify|breaks|typographer
calendly: STRING
integration: integration.calendly
button_text: STRING
closed_text: STRING
pending_text: STRING
try_again_text: STRING
cancel_text: STRING
prefill:
foo: bar
utm_source: STRING
utm_campaign: STRING
utm_medium: STRING
utm_term: STRING
ask: STRING
title: STRING
description: STRING
image:
url: STRING
alt: STRING
rows:
- - cell: STRING
value: ANY
button_style: action|radio|text