Operate enmeshed

Since the Connector is based on the Runtime, all Modules of the Runtime are also available in the Connector.

Additionally, the Connector defines its own Modules that only make sense in the context of a Connector and are therefore not defined in the Runtime.

Read more about the Module configuration on the icon in each title.

AMQP Publisher

This module is deprecated in favor of the Message Broker Publisher Module.

This Module proxies all events of the internal event bus of the Connector to an exchange in a configurable AMQP server.

Compared to webhooks, this gives you the full feature set of a message broker. There are multiple scenarios where this Module outweighs the Webhooks Module. For example:

  • You need persistence for the triggered events.
  • You want to integrate enmeshed into an already existing message broker.

Auto Accept Pending Relationships

It is not recommended to use this Module for production scenarios.

The autoAcceptPendingRelationships Module listens to the events about changed Relationships. It immediately accepts pending Relationships.

Keep in mind that you need to synchronize the state of the Connector with the Backbone in order to receive changed Relationships. The sync Module automates this, but you can also do this manually by calling the /api/v2/Account/Sync route.

Core HTTP API

This Module contains the HTTP API with all enmeshed base functionalities.

Message Broker Publisher

The Message Broker Publisher Module allows you to publish events to different message brokers. Supported message brokers are: AMQP, PubSub, Redis and MQTT.

Compared to webhooks, this gives you the full feature set of these message brokers. There are multiple scenarios where this Module outweighs the Webhooks Module. For example:

  • You need persistence or retries for the triggered events.
  • You want to integrate enmeshed into an already existing message broker.

Sync

The sync Module regularly fetches changes from the Backbone (e.g. new Messages / new or changed Relationships). This process automatically triggers the events used by other Modules like the webhooks Module.

The sync Module and the sse Module are not compatible. The sync Module will be disabled if both are active.

PubSub Publisher

This module is deprecated in favor of the Message Broker Publisher Module.

This Module proxies all events of the internal event bus of the Connector to a configurable PubSub instance.

Compared to webhooks, this gives you the full feature set of a message broker. There are multiple scenarios where this Module outweighs the Webhooks Module. For example:

  • You need persistence for the triggered events.
  • You want to integrate enmeshed into an already existing message broker.

Webhooks

With the REST API, pull mechanisms are supported. However, as there are many bidirectional scenarios within enmeshed, a push mechanism is favorable: the Connector is synchronizing its state with the Backbone and notifies the organization’s backend services about changes.

For this, the Connector supports the configuration of webhooks which are called every time a specific Connector Event is triggered (e.g. a new Message has been received => transport.messageReceived).

Keep in mind that you need to synchronize the state of the Connector with the Backbone in order to receive events. The sync Module automates this, but you can also do this manually by calling the /api/v2/Account/Sync route.

sse (Server-Sent Events)

The sse Module allows the Connector to receive events from the Backbone without exposing the Connector to the Internet. The Connector reacts to these events and ensures automatic synchronization.

Requesting Modules

In case you need a further Module for your application, please state a feature request.