Skip to content

Commit 515762c

Browse files
committed
add http bridge documentation
1 parent a54c90b commit 515762c

18 files changed

+52
-11
lines changed

content/en/docs/appstore/use-content/platform-supported-content/services/event-broker.md

Lines changed: 52 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,13 @@ From here, you can manage the default access settings:
9393
This feature is currently in [Private Beta](/releasenotes/beta-features/). Contact your Customer Success Manager or Account Manager for further assistance.
9494
{{% /alert %}}
9595

96-
Mendix Event Broker Bridges allow for the integration of the Mendix Event Broker with other technologies, such as AWS SQS, AWS S3, or Google Pub/Sub, to send and receive events between your Mendix Cloud landscape and technologies outside of your Mendix Cloud landscape.
96+
Mendix Event Broker Bridges facilitate integration between the Mendix Event Broker and external technologies, such as AWS SQS and HTTP. These bridges enable the exchange of events between your Mendix Cloud environment and external systems, ensuring efficient communication across diverse technological landscapes.
9797

9898
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges.png" class="no-border" width="850" >}}
9999

100100
### Standard Message Format
101101

102-
To move an event from SQS to Mendix Event Broker, a message must contain the following message attributes and start with `ce_`:
102+
Every event must carry four mandatory CloudEvents core attributes, each prefixed with ce_:
103103

104104
* id as `ce_id`
105105
* source as `ce_source`
@@ -112,21 +112,21 @@ See [CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#requir
112112

113113
Technical Contacts with a license to the Mendix Event Broker can manage this feature from the **Event Broker Bridges** tab on the [Event Broker Manager](https://broker.mendix.com/) page.
114114

115-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_create_1.png" class="no-border" width="850" >}}
115+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create.png" class="no-border" width="850" >}}
116116

117117
The creation process contains three steps on the Mendix side and policies that need to be implemented on the AWS side.
118118

119119
### Select a Service to Configure
120120

121121
Within the scope of the current Public Beta for this feature, Mendix Event Broker Bridges can transport events between the Mendix Event Broker and AWS SQS. Other options in the list are currently not available for use.
122122

123-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_create_2.png" class="no-border" width="850" >}}
123+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_2_sqs.png" class="no-border" width="850" >}}
124124

125125
### Configuration Details
126126

127127
The next step of configuration is to select a [Space](#manage-mx-broker), Name, and Region for the bridge to operate in.
128128

129-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_create_3.png" class="no-border" width="850" >}}
129+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_3_sqs.png" class="no-border" width="850" >}}
130130

131131
### Choose the Business Events to Integrate
132132

@@ -135,25 +135,25 @@ The user must select events from the Event Broker landscape of events to send to
135135
1. Select ***Add Business Events** and search for the appropriate events.
136136
2. Select the checkbox for the event you want to add, then click **Select**.
137137

138-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_create_4.png" class="no-border" width="850" >}}
138+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_4_sqs.png" class="no-border" width="850" >}}
139139

140140
3. Configure each event with its own SQS URL for each direction that the event will be integrated.
141141

142-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_create_5.png" class="no-border" width="850" >}}
142+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_5_sqs.png" class="no-border" width="850" >}}
143143

144144
4. Confirm the configuration with the AWS Access Policy.
145145

146-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_create_6.png" class="no-border" width="850" >}}
146+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_6_sqs.png" class="no-border" width="850" >}}
147147

148148
5. After all events have been configured, click **Start** to start the Mendix Event Broker Bridge. This process will take several minutes to complete.
149149

150-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_create_7.png" class="no-border" width="850" >}}
150+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_7_sqs.png" class="no-border" width="850" >}}
151151

152-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_management.png" class="no-border" width="850" >}}
152+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_management_sqs.png" class="no-border" width="850" >}}
153153

154154
Once the Mendix Event Broker Bridge has been successfully deployed, its configuration and status can be viewed on the **Overview** page.
155155

156-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_bridges_overview.png" class="no-border" width="850" >}}
156+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_overview_sqs.png" class="no-border" width="850" >}}
157157

158158
### Configure AWS Access Policy for Sending Messages to Mendix
159159

@@ -197,6 +197,47 @@ Add this object to your Access Policy of the AWS SQS queue if it is receiving me
197197
}
198198
```
199199

200+
### Configuring a Bridge with HTTP {#bridge-with-http}
201+
202+
The HTTP Bridge allows users to send events from external systems to the Mendix Event Broker using HTTP requests. This bridge is one-way: **HTTP to Event Broker**. Below are the steps to configure an HTTP Bridge:
203+
204+
#### 1. Select a Service to Configure
205+
- Select **HTTP** as the bridge type.
206+
207+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/event_broker_bridges_create_2_http.png" class="no-border" width="850" >}}
208+
209+
#### 2. Configure Service
210+
- Select the appropriate:
211+
1. **Event Broker Space** – Choose the space where the bridge will operate.
212+
2. **Bridge Name** – Enter your desired name for the bridge.
213+
214+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/event_broker_bridges_create_3_http.png" class="no-border" width="850" >}}
215+
216+
#### 3. Choose the Business Events to Integrate
217+
- The step starts with no events selected.
218+
- Click **Add Business Events** to open a popup displaying all events managed by the Event Broker (including Mendix app-defined and uploaded AsyncAPI events).
219+
- Only events that can **subscribe** are displayed, as this bridge is one-way.
220+
- Once events are selected, the URL for the HTTP connection is automatically generated. No further configuration is required.
221+
222+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/event_broker_bridges_create_4_http.png" class="no-border" width="850" >}}
223+
224+
#### 4. Confirmation
225+
- The confirmation step is similar to other bridges, with a different informational message for HTTP-specific details.
226+
227+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/event_broker_bridges_create_5_http.png" class="no-border" width="850" >}}
228+
229+
### HTTP Bridge Overview
230+
231+
The HTTP Bridge has the same look and feel as other bridges, with the exception of a unique HTTP-specific icon.
232+
233+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/event_broker_bridges_create_6_http.png" class="no-border" width="850" >}}
234+
235+
### HTTP Bridge Details Overview
236+
237+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/event_broker_bridges_create_7_http.png" class="no-border" width="850" >}}
238+
239+
To run the HTTP bridge from your client, include a Bearer token in the request header.
240+
200241
## Externally Defined Events {#externally-defined-events}
201242

202243
Externally defined events refer to events that are defined outside the Mendix application, specifically outside of Studio Pro.
231 KB
Loading
213 KB
Loading
212 KB
Loading
255 KB
Loading
348 KB
Loading
344 KB
Loading
241 KB
Loading
240 KB
Loading
246 KB
Loading

0 commit comments

Comments
 (0)