Element details

type: meya.whatsapp.integration
class: WhatsAppIntegration
path: /meya/whatsapp/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	Specifies the GridQL to filter `rx_sub`, `rx`, `tx`, `tx_pub`entries. Check the integration filtering guidefor more info.	○	○	rx_sub: true rx: true tx: true 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
account_sid	Twilio project Account SID.	◉	○		str
auth_token	Twilio project auth token. This field is being deprecated, switch to api_key_sid and api_key_secret as soon as possible. For more information, see https://www.twilio.com/console/project/api-keys	○	○	null	str
api_key_sid	Twilio API Key SID. Access https://www.twilio.com/console/project/api-keys to manage API Keys.	○	○	null	str
api_key_secret	Twilio API Key secret. Access https://www.twilio.com/console/project/api-keys to manage API Keys.	○	○	null	str
phone_number	Twilio active number for use with Meya. Note, this can also be a Message Service ID. For SMS/calls this will generally be a standard E.164 number e.g. +15554440000. For WhatsApp this needs to be a prefixed E.164 number e.g. whatsapp:+15554440000. For a message service, you just use the Message Service ID directly e.g. MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.	○	○	null	str
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
extra_sms_status_events	List of SMS events that you want to process. This is useful in case you need specific behaviours depending on the status of the message. For WhatsApp Integration the `TwilioSmsSentEvent` is changed to `WhatsAppSentEvent` for standard messages and `WhatsAppSentTemplateEvent` for template messages. For more information on WhatsApp template access: https://www.twilio.com/docs/whatsapp/tutorial/send-whatsapp-notification-messages-templates	○	○	[]	list
enable_rich_content	Use the Twilio Content API to render quick replies and list pickers in WhatsApp. Note, WhatsApp only allows a maximum of 3 quick replies for a message, therefore the integration will always truncate the set of Meya quick replies or buttons to the first 3 items.	○	○	false	bool
list_picker_default_text	The default text for the list picker widget. This is only used if the `ask` property is not set in the ask button component.	○	○	"..."	str
list_picker_default_button_text	The default button text for the list picker widget. This is only used if the `label` property is not set in the adk button component.	○	○	"Select"	str

Usage reference

Basic

type: meya.whatsapp.integration
account_sid: STRING

Full

type: meya.whatsapp.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
account_sid: STRING
auth_token: STRING
api_key_sid: STRING
api_key_secret: STRING
phone_number: STRING
markdown:
  - format|linkify|breaks|typographer
typing: false
extra_sms_status_events:
  - accepted|queued|sending|sent|failed|delivered|undelivered|receiving|received|read
enable_rich_content: false
list_picker_default_text: STRING
list_picker_default_button_text: STRING