Element details

type: meya.facebook.messenger.integration
class: FacebookMessengerIntegration
path: /meya/facebook/messenger/integration/integration.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
enabled	Enables the integration, allowing it to process events and HTTP/WS entries.	○	○	true	bool
filter		○	○	rx_sub: true rx: true tx: "\nmeya.event.entry.interactive\nOR meya.csp.event\nOR meya.button.event.click\n OR meya.form.event.submit\n" tx_pub: true	IntegrationFilter
verify_token	The token to be verified for each incoming request. You need to add the `verify_token=YOUR_TOKEN` query parameter to integration's webhook URL.	○	○	null	str
max_attachment_size	Controls maximum attachment size supported by the integration in bytes.	○	○	null	int
markdown	The markdown features that are supported by this integration. Check the Markdown guide for more info.	○	○	false	list bool
typing	When set to `false`, all typing indicators received by the integration will be ignored.	○	○	true	bool
avatar		○	○	crop: circle	CspIntegrationAvatar
agent_command_prefix		○	○	"/"	str
transcript		○	○	count: 25 user_prefix: user bot_prefix: bot agent_prefix: agent note_prefix: 📝	CspIntegrationTranscript
agent		○	○	name: avatar:	AgentSpec
mark_incoming_as_read		○	○	true	bool
app_id	Facebook Messenger App ID	◉	○		int
pages	Pages connected to the app	◉	○		list
collect	Fields you want to retrieve from the user profile, e.g. first name, last name. For more information see https://developers.facebook.com/docs/messenger-platform/identity/user-profile.This property also allows you to configure in which data scope (event\|thread\|user) each data point should be stored.	○	○	first_name: last_name: profile_pic: locale: timezone: gender:	FacebookMessengerCollectConfig

Usage reference

Basic

type: meya.facebook.messenger.integration
app_id: 123
pages:
  - page_id: 123
    access_token: STRING

Full

type: meya.facebook.messenger.integration
spec:
  type: STRING
  data:
    STRING: ANY
  timeout: 123
  trigger_when: ANY
enabled: false
filter:
  rx_sub: STRING
  rx: STRING
  tx: STRING
  tx_pub: STRING
verify_token: STRING
max_attachment_size: 123
markdown:
  - format|linkify|breaks|typographer
typing: false
avatar:
  crop: circle|square
agent_command_prefix: STRING
transcript:
  count: 123
  user_prefix: STRING
  bot_prefix: STRING
  agent_prefix: STRING
  note_prefix: STRING
agent:
  name: full|first|first_initial|first_last_initial|first_initial_last_initial
  avatar:
    image: STRING
    crop: circle|square
    monogram: full|first|first_initial|first_last_initial|first_initial_last_initial
mark_incoming_as_read: false
app_id: 123
pages:
  - page_id: 123
    access_token: STRING
collect:
  first_name: user|user_overwrite|thread|thread_overwrite|event
  last_name: user|user_overwrite|thread|thread_overwrite|event
  profile_pic: user|user_overwrite|thread|thread_overwrite|event
  locale: user|user_overwrite|thread|thread_overwrite|event
  timezone: user|user_overwrite|thread|thread_overwrite|event
  gender: user|user_overwrite|thread|thread_overwrite|event