element

This is the base integration element that is used by all other
integration elements.

This is an abstract element and should not be used directly in
your BFML.

When you implement your own custom integrations
you will inherit from this element's Python class.

Element details

type: meya.integration.element
class: Integration
path: /meya/integration/element/element.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_pubentries. 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

Usage reference

Basic

type: meya.integration.element

Full

type: meya.integration.element
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