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. It provides event-driven integration within your business processes by sending an event to an event bus. For example, use it to publish an order-created event that triggers a fulfillment rule in EventBridge.

To start a process instance from an event in Amazon EventBridge, 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.

note

Use Camunda 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.

Use an outbound connector

Configuration

Authentication

Property	Type	Required	Description	Example
Authentication	Dropdown	Yes	The AWS authentication strategy: Credentials (SaaS/Self-Managed): Use this option if you have a pair of access and secret keys from your AWS account administrator. Default Credentials Chain (Hybrid/Self-Managed only): Use this option if your system relies on implicit authentication, such as role-based authentication, credentials supplied through environment variables, or files on the target host. It uses the Default Credential Provider Chain to resolve credentials. Shown when no AWS credential is selected.
Access key	String	Yes, if Authentication is Credentials	The access key of an IAM user with permissions to send events to Amazon EventBridge.
Secret key	String	Yes, if Authentication is Credentials	The secret key of the IAM user with the access key above.

AWS authentication types

There are two options to authenticate the connector with AWS:

• Choose Credentials in the Authentication dropdown if you have a valid pair of access and secret keys provided by your AWS account administrator. This option is applicable for both SaaS and Self-Managed users.
• Choose Default Credentials Chain (Hybrid/Self-Managed only) in the Authentication dropdown if your system is configured as an implicit authentication mechanism, such as role-based authentication, credentials supplied via environment variables, or files on target host. This option is applicable only for Self-Managed or hybrid distribution. This approach uses the Default Credential Provider Chain to resolve required credentials.

Region

Property	Type	Required	Description	Example
Region	String	Yes	The AWS region where your EventBridge event bus resides.

Operations

Send event

Send an event to an Amazon EventBridge event bus.

Input parameters

Property	Type	Required	Description	Example
Source	String	Yes	The value that identifies the service that generated the event.
Detail type	String	Yes	The type of event being sent. Refer to the Amazon documentation for more information on Source and Detail type.
Event bus name	Text	Yes	The name of the destination event bus. Refer to the Amazon EventBridge documentation for more details on event buses.
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. Here is an example of the 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
    }
  ]
}

To map the response into process variables, use Result variable to store the whole response, or Result expression to map individual fields, for example = { "eventId": response.entries[1].eventId }.

Troubleshooting

To learn about general error handling in Camunda, see BPMN errors and failing jobs.

Further resources

• Amazon EventBridge documentation
• Learn about other connectors available in Camunda to integrate with different systems and services.
• Learn more about using connectors.