Skip to content

Commit c2a60b3

Browse files
quinntracyquinntracy
committed
Review
1 parent e61a594 commit c2a60b3

1 file changed

Lines changed: 53 additions & 56 deletions

File tree

  • content/en/docs/marketplace/platform-supported-content/services

‎content/en/docs/marketplace/platform-supported-content/services/event-broker.md‎

Lines changed: 53 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,17 @@ See [CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#requir
119119

120120
For HTTP Bridges, specific headers are required for authentication.
121121

122-
**Required Header:**
122+
##### Required Header
123123

124-
* **Authorization** – Must be set as a Bearer token using the Personal Access Token (PAT) generated during bridge configuration.
125-
126-
Example: `Authorization: Bearer <your-personal-access-token>`
124+
* **Authorization** – must be set as a Bearer token using the Personal Access Token (PAT) generated during bridge configuration; for example: `Authorization: Bearer <your-personal-access-token>`
127125

128126
For details on how to obtain your Bearer token, see [Using the HTTP Bridge](#using-the-http-bridge).
129127

130-
**Optional Headers:**
128+
##### Optional Headers
131129

132130
You can include additional HTTP headers in your request to provide event metadata, such as:
133131

134-
* `ce_time` – Sets the published time of the event (example: `2025-06-13T15:36:52.148542+02:00`)
132+
* `ce_time` – sets the published time of the event; for example: `2025-06-13T15:36:52.148542+02:00`
135133

136134
All custom HTTP headers will be forwarded as Kafka headers by default.
137135

@@ -145,41 +143,41 @@ Technical Contacts with a license to the Mendix Event Broker can manage this fea
145143

146144
2. Select one of the following bridge types:
147145

148-
* **AWS SQS** – Bidirectional bridge using the [Amazon Simple Queue Service](https://aws.amazon.com/sqs/) to send and receive events.
149-
* **HTTP** – One-way bridge that uses HTTP requests to send events from external systems to the Mendix Event Broker.
150-
* **Azure Blob Storage** – One-way bridge that receives events via Azure object storage.
151-
* **AWS S3** – One-way bridge that receives events via AWS object storage.
146+
* **AWS SQS** – bidirectional bridge using the [Amazon Simple Queue Service](https://aws.amazon.com/sqs/) to send and receive events
147+
* **HTTP** – one-way bridge that uses HTTP requests to send events from external systems to the Mendix Event Broker
148+
* **Azure Blob Storage** – one-way bridge that receives events via Azure object storage
149+
* **AWS S3** – one-way bridge that receives events via AWS object storage
152150

153151
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/ebb_general_bridge_create.png" class="no-border" >}}
154152

155-
3. Click **Next** to continue with creating your bridge.
153+
1. Click **Next** to continue creating your bridge.
156154

157155
* For instructions on configuring AWS SQS, see [Configuring a Bridge with AWS SQS](#bridge-with-aws-sqs).
158156
* For instructions on configuring HTTP, see [Configuring a Bridge with HTTP](#bridge-with-http).
159157
* For instructions on configuring Azure Blob Storage, see [Configuring a Bridge with Azure Blob Storage](#bridge-with-azure-blob-storage).
160158
* For instructions on configuring AWS S3, see [Configuring a Bridge with AWS S3](#bridge-with-aws-s3).
161159

162-
4. After configuring the service and connecting events (as described in the bridge-specific sections above), click **Start** on the confirmation screen to deploy the bridge.
160+
2. After configuring the service and connecting events (as described in the bridge-specific sections above), click **Start** on the confirmation screen to deploy the bridge.
163161

164162
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/ebb_general_bridge_start.png" class="no-border" >}}
165163

166164
Once the bridge has been successfully deployed, its configuration and status can be viewed on the **Overview** page.
167165

168166
### Configuring a Bridge with AWS SQS {#bridge-with-aws-sqs}
169167

170-
The creation process for AWS SQS bridges includes two further steps on the Mendix side and policies that need to be implemented on the AWS side.
168+
The creation process for AWS SQS bridges includes two additional steps on the Mendix side and policies that need to be implemented on the AWS side.
171169

172170
#### Configure Service
173171

174-
Configure the service by filling out the following:
172+
1. Configure the service by filling out the following:
175173

176174
* **Event Broker Space** – the space where the bridge will operate
177-
* **Bridge Name** – the name you want to call the bridge
178-
* **AWS Region** – the AWS region where your bridge operates
175+
* **Name** – the name you want to call the bridge
176+
* **AWS region** – the AWS region where your bridge operates
179177

180-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-sqs/ebb_aws_sqs_configure.png" class="no-border" width="400" >}}
178+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-sqs/ebb_aws_sqs_configure.png" class="no-border" width="400" >}}
181179

182-
Click **Next** to continue the configuration.
180+
2. Click **Next** to continue the configuration.
183181

184182
#### Connect Events
185183

@@ -188,11 +186,11 @@ Select the business events to integrate with AWS SQS:
188186
1. Click **Add Business Events** to open a dialog displaying all events managed by the Event Broker, including Mendix app-defined events and uploaded AsyncAPI events.
189187
2. Select the checkbox for the event(s) you want to add, then click **Select**.
190188

191-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-sqs/ebb_aws_sqs_choose_events.png" class="no-border" width="400" >}}
189+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-sqs/ebb_aws_sqs_choose_events.png" class="no-border" width="400" >}}
192190

193191
3. Configure each event with its own SQS URL for each direction the event will be integrated.
194192

195-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-sqs/ebb_aws_sqs_connect_events.png" class="no-border" width="400" >}}
193+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-sqs/ebb_aws_sqs_connect_events.png" class="no-border" width="400" >}}
196194

197195
4. Click **Next** to continue.
198196

@@ -214,7 +212,7 @@ You need to configure AWS access policies for both sending and receiving message
214212

215213
##### Sending Messages to Mendix
216214

217-
Add this object to the Access Policy of your AWS SQS queue if it is sending messages to Mendix.
215+
Add the object below to the Access Policy of your AWS SQS queue if it is sending messages to Mendix.
218216

219217
```
220218
{
@@ -234,7 +232,7 @@ Add this object to the Access Policy of your AWS SQS queue if it is sending mess
234232

235233
##### Receiving Messages from Mendix
236234

237-
Add this object to your Access Policy of the AWS SQS queue if it is receiving messages from Mendix.
235+
Add the object below to your Access Policy of the AWS SQS queue if it is receiving messages from Mendix.
238236

239237
```
240238
{
@@ -258,15 +256,15 @@ Add this object to your Access Policy of the AWS SQS queue if it is receiving me
258256

259257
#### Configure Service
260258

261-
Configure the service by filling out the following:
259+
1. Configure the service by filling out the following:
262260

263261
* **Event Broker Space** – the space where the bridge will operate
264-
* **Bridge Name** – the name you want to call the bridge
265-
* **AWS Region** – the AWS region where your bridge operates
262+
* **Name** – the name you want to call the bridge
263+
* **AWS region** – the AWS region where your bridge operates
266264

267-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/ebb_http_configure.png" class="no-border" width="400" >}}
265+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/ebb_http_configure.png" class="no-border" width="400" >}}
268266

269-
Click **Next** to connect events to your bridge.
267+
2. Click **Next** to connect events to your bridge.
270268

271269
#### Connect Events
272270

@@ -275,7 +273,7 @@ Select the business events to integrate with the HTTP Bridge:
275273
1. Click **Add Business Events** to open a dialog displaying all events managed by the Event Broker, including Mendix app-defined events and uploaded AsyncAPI events. Only events capable of subscribing are shown, as this bridge operates in one direction.
276274
2. Select the event(s) to integrate. Once selected, the URL for the HTTP connection is automatically generated.
277275

278-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/ebb_http_connect_events.png" class="no-border" width="400" >}}
276+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/http/ebb_http_connect_events.png" class="no-border" width="400" >}}
279277

280278
3. Click **Next** to proceed to the confirmation screen.
281279

@@ -289,24 +287,24 @@ Once the Mendix Event Broker Bridge has been successfully deployed, its configur
289287

290288
To run the HTTP bridge from your client, include a Bearer token in the request header.
291289

292-
1. Open the HTTP bridge details using **Options** ({{% icon name="three-dots-menu-horizontal" %}}) menu on the Overview page.
290+
1. Open the HTTP bridge details using the **Options** ({{% icon name="three-dots-menu-horizontal" %}}) menu on the **Overview** page.
293291
2. Add the **Bearer token**.
294292

295293
### Configuring a Bridge with Azure Blob Storage {#bridge-with-azure-blob-storage}
296294

297295
#### Configure Service
298296

299-
Configure the service by filling out the following:
297+
1. Configure the service by filling out the following:
300298

301299
* **Event Broker Space** – the space where the bridge will operate
302-
* **Bridge Name** – the name you want to call the bridge
300+
* **Name** – the name you want to call the bridge
303301
* **Storage Account** – the storage account to access
304302
* **Storage SAS Token** – the storage SAS Token
305303
* **Container Path** – the path of the container where the messages will be stored
306304

307-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/azure-blob-storage/ebb_azure_blob_configure.png" class="no-border" >}}
305+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/azure-blob-storage/ebb_azure_blob_configure.png" class="no-border" >}}
308306

309-
Click **Next** to connect events to your bridge.
307+
2. Click **Next** to connect events to your bridge.
310308

311309
#### Connect Events
312310

@@ -315,7 +313,7 @@ Select the business events to integrate with Azure Blob Storage:
315313
1. Click **Add Business Events** to open a dialog displaying all events managed by the Event Broker, including Mendix app-defined events and uploaded AsyncAPI events. Only events capable of publishing are shown, as this bridge operates in one direction.
316314
2. Select the event(s) to integrate and specify the prefix path for event storage.
317315

318-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/azure-blob-storage/ebb_azure_blob_connect_events.png" class="no-border" >}}
316+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/azure-blob-storage/ebb_azure_blob_connect_events.png" class="no-border" >}}
319317

320318
3. Click **Next** to proceed to the confirmation screen.
321319

@@ -330,22 +328,22 @@ Once the Mendix Event Broker Bridge has been successfully deployed, its configur
330328

331329
#### Configure Service
332330

333-
Configure the service by filling out the following:
331+
1. Configure the service by filling out the following:
334332

335333
* **Event Broker Space** – the space where the bridge will operate
336-
* **Bridge Name** – the name you want to call the bridge
334+
* **Name** – the name you want to call the bridge
337335
* **Bucket** – the path of the container where the messages will be stored
338336
* **AWS Region for Bucket** – the AWS region where your S3 bucket is located
339-
* **AWS Role to Assume** – the Amazon Resource Name (ARN) of the IAM role that the Event Broker Bridge will assume to access your S3 bucket. This role must be configured with appropriate permissions and a trust policy allowing the Event Broker to assume it.
340-
* **AWS Role's External ID** – a unique identifier that provides additional security when the Event Broker assumes your AWS role. This shared secret ensures that only authorized Mendix Event Broker instances can assume the role.
337+
* **AWS Role (to Assume)** – the Amazon Resource Name (ARN) of the IAM role that the Event Broker Bridge will assume to access your S3 bucket; this role must be configured with appropriate permissions and a trust policy allowing the Event Broker to assume it
338+
* **AWS Role's External Id** – a unique identifier that provides additional security when the Event Broker assumes your AWS role; this shared secret ensures that only authorized Mendix Event Broker instances can assume the role
341339

342340
{{% alert color="info" %}}
343341
For detailed instructions on how to create the IAM role and obtain these values, see [Configure AWS Authentication for S3 Bridge](#configure-aws-s3-authentication).
344342
{{% /alert %}}
345343

346344
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-s3/ebb_aws_s3_configure.png" class="no-border" >}}
347345

348-
Click **Next** to connect events to your bridge.
346+
2. Click **Next** to connect events to your bridge.
349347

350348
#### Connect Events
351349

@@ -354,7 +352,7 @@ Select the business events to integrate with AWS S3:
354352
1. Click **Add Business Events** to open a dialog displaying all events managed by the Event Broker, including Mendix app-defined events and uploaded AsyncAPI events. Only events capable of publishing are shown, as this bridge operates in one direction.
355353
2. Select the event(s) to integrate and specify the prefix path for event storage.
356354

357-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-s3/ebb_aws_s3_connect_events.png" class="no-border" >}}
355+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-s3/ebb_aws_s3_connect_events.png" class="no-border" >}}
358356

359357
3. Click **Next** to proceed to the confirmation screen.
360358

@@ -375,7 +373,7 @@ The Mendix Event Broker runs in AWS and uses cross-account authentication to sec
375373
* An S3 bucket where business events will be stored
376374
* The Mendix Event Broker AWS account ID: `044806572671`
377375

378-
##### Step 1: Create an IAM Role with a Trust Policy
376+
##### Create an IAM Role with a Trust Policy
379377

380378
The trust policy defines which AWS accounts can assume the role.
381379

@@ -388,13 +386,12 @@ The trust policy defines which AWS accounts can assume the role.
388386
7. Click **Next**.
389387

390388
{{% alert color="info" %}}
391-
The external ID acts as a shared secret between Mendix and your AWS account, preventing the confused deputy problem and ensuring that only authorized Event Broker instances can assume your role.
389+
The external ID acts as a shared secret between Mendix and your AWS account. This prevents the confused deputy problem and ensures that only authorized Event Broker instances can assume your role.
392390
{{% /alert %}}
393391

392+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-s3/create-a-cross-account-role-in-AWS.png" class="no-border" width="400" >}}
394393

395-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/aws-s3/create-a-cross-account-role-in-AWS.png" class="no-border" width="400" >}}
396-
397-
##### Step 2: Attach Permissions Policy to the Role
394+
##### Attach Permissions Policy to the Role
398395

399396
The permissions policy defines what actions the Event Broker can perform once the role is assumed.
400397

@@ -434,15 +431,15 @@ The permissions policy defines what actions the Event Broker can perform once th
434431
The policy above grants the minimum required permissions for the Event Broker to write business events to your S3 bucket. Adjust the permissions as needed based on your security requirements.
435432
{{% /alert %}}
436433

437-
##### Step 3: Complete Role Creation
434+
##### Complete Role Creation
438435

439436
1. Provide a name for your role (for example, `EventBrokerS3AccessRole`).
440437
2. Review the role configuration and click **Create role**.
441-
3. Once created, open the role and copy the **Role ARN** (it will look like `arn:aws:iam::YOUR_ACCOUNT_ID:role/EventBrokerS3AccessRole`).
438+
3. Once created, open the role and copy the **Role ARN** (it will look like this: `arn:aws:iam::YOUR_ACCOUNT_ID:role/EventBrokerS3AccessRole`).
442439

443-
##### Step 4: Configure the Bridge
440+
##### Configure the Bridge
444441

445-
Use the Role ARN and External ID when configuring your AWS S3 bridge in the Event Broker Manager:
442+
Use the Role ARN and External ID when configuring your AWS S3 bridge in the Event Broker Manager.
446443

447444

448445
### Managing Bridges
@@ -455,11 +452,11 @@ You can edit HTTP, Azure Blob Storage, and AWS S3 bridges to modify their config
455452

456453
{{% alert color="info" %}}You can only edit a bridge when its status is **Running**.{{% /alert %}}
457454

458-
**What You Can Edit:**
455+
You can edit:
459456

460-
* **HTTP Bridge** – Add or remove business events
461-
* **Azure Blob Storage Bridge** – Add or remove business events, update Storage Account, Storage SAS Token, Container Path, or Prefix Path
462-
* **AWS S3 Bridge** – Add or remove business events, update Bucket, AWS Region for Bucket, or Prefix Path
457+
* **HTTP Bridge** – add or remove business events
458+
* **Azure Blob Storage Bridge** – add or remove business events, update Storage Account, Storage SAS Token, Container Path, or Prefix Path
459+
* **AWS S3 Bridge** – add or remove business events, update Bucket, AWS Region for Bucket, or Prefix Path
463460

464461
To edit a bridge:
465462

@@ -479,12 +476,12 @@ To edit a bridge:
479476
1. Navigate to the event you want to remove and click **Remove**. Removed events will display a **Removed** badge, and their name and metadata will appear grayed out.
480477
2. Re-add a removed event by clicking **Add** before applying changes.
481478

482-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/edit-bridge/http_edit_mode.png" class="no-border" >}}
479+
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/edit-bridge/http_edit_mode.png" class="no-border" >}}
483480

484481
* **Update Service Configuration** (Azure Blob Storage and AWS S3 only):
485482

486-
* **Azure Blob Storage** – Update the Storage Account, Storage SAS Token, Container Path, or Prefix Path as needed.
487-
* **AWS S3** – Update the Bucket, AWS Region for Bucket, or Prefix Path as needed.
483+
* **Azure Blob Storage** – update the Storage Account, Storage SAS Token, Container Path, or Prefix Path as needed
484+
* **AWS S3** – update the Bucket, AWS Region for Bucket, or Prefix Path as needed
488485

489486
**HTTP**
490487
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/edit-bridge/ebb_http_edit_mode.png" class="no-border" >}}

0 commit comments

Comments
 (0)