Amazon EventBridge connector
Send events from your BPMN process to Amazon EventBridge for further processing or routing to other AWS services.
About this connector
The Amazon EventBridge connector is an outbound connector that integrates your BPMN service with Amazon EventBridge. Use it to send events from your processes to an event bus, where rules can route them to other AWS services. It provides event-driven integration within your business processes. For example, use it to publish an order-created event that triggers a fulfillment rule in EventBridge.
To start a process instance from an Amazon EventBridge event instead, see the Amazon EventBridge Webhook connector.
For more information, refer to the Amazon EventBridge documentation.
Prerequisites
To use the Amazon EventBridge connector, you need:
- An AWS account with permission to send events to EventBridge. Refer to the AWS documentation for more information.
- An access key and secret key of a user with the appropriate permissions.
Use secrets to avoid exposing your AWS IAM credentials as plain text. Refer to our documentation on managing secrets to learn more.
Use this connector
New to using an outbound connector? Learn how to add and use this type of connector, apply element templates, use connector secrets, handle results and errors, and more.
Configuration
Authentication
| Property | Type | Required | Description | Example |
|---|---|---|---|---|
| AWS credential | Configuration | No | Select a saved AWS credential with an optional default region, or enter the authentication details and a region in the fields below. Learn more about credentials. | |
| Authentication | Dropdown | Yes, if no AWS credential is set | The AWS authentication strategy:
| |
| Access key | String | Yes, if Authentication is Credentials | The IAM access key of a user with the permissions to send events to Amazon EventBridge. Shown when no AWS credential is selected. | |
| Secret key | String | Yes, if Authentication is Credentials | The IAM secret key of the user with the access key above. Shown when no AWS credential is selected. |
Region
| Property | Type | Required | Description | Example |
|---|---|---|---|---|
| Region | String | Yes, if no AWS credential is set | The AWS region where your EventBridge resides. | |
| Region | String | Yes, if the credential has no default region | Overrides the default region of the selected AWS credential. Shown when an AWS credential is selected. |
Operations
Send event
Send an event to an Amazon EventBridge event bus.
Input parameters
| Property | Type | Required | Description | Example |
|---|---|---|---|---|
| Event bus name | Text | Yes | The name of the destination event bus. Refer to the Amazon EventBridge documentation for more details on event buses. | |
| Source | String | Yes | The value that identifies the service that generated the event. Refer to the Amazon documentation for more information. | |
| Detail type | String | Yes | The type of event being sent. Refer to the Amazon documentation for more information. | |
| Event payload | String | Yes | A JSON object that contains information about the event. |
Output
The connector returns the original response from the Amazon EventBridge service, including the sdkResponseMetadata and sdkHttpMetadata. Example response:
{
"sdkResponseMetadata": {
"requestId": "766647a2-835a-418b-9161-94245d0c93a3"
},
"sdkHttpMetadata": {
"httpHeaders": {
"Content-Length": "85",
"Content-Type": "application/x-amz-json-1.1",
"Date": "Fri, 23 Jun 2023 08:39:22 GMT",
"x-amzn-RequestId": "766647a2-835a-418b-9161-94245d0c93a3"
},
"httpStatusCode": 200,
"allHttpHeaders": {
"x-amzn-RequestId": ["766647a2-835a-418b-9161-94245d0c93a3"],
"Content-Length": ["85"],
"Date": ["Fri, 23 Jun 2023 08:39:22 GMT"],
"Content-Type": ["application/x-amz-json-1.1"]
}
},
"failedEntryCount": 0,
"entries": [
{
"eventId": "bb86b1af-9abb-0f8e-28c2-c69c24c35e05",
"errorCode": null,
"errorMessage": null
}
]
}
Troubleshooting
To learn about general error handling in Camunda, see BPMN errors and failing jobs.