Skip to main content

Amazon EventBridge Connector

The Amazon EventBridge Connector integrates your BPMN service with Amazon EventBridge, enabling the sending of events from your workflows for further processing or routing to other AWS services. It provides seamless event-driven integration within your business processes.

For more information, refer to the Amazon EventBridge documentation.

Prerequisites​

Before using the Amazon EventBridge Connector, ensure you have the necessary permissions in your AWS account to send events to EventBridge. You will need an access key and secret key of a user with the appropriate permissions. Refer to the AWS documentation for more information.

note

Use Camunda secrets to avoid exposing your AWS IAM credentials as plain text. Refer to our documentation on managing secrets to learn more.

Create an Amazon EventBridge Connector task​

To use the Amazon EventBridge Connector in your process, you can either change the type of existing task by clicking on it and using the wrench-shaped Change type context menu icon, or create a new Connector task by using the Append Connector context menu. Refer to our guide on using Connectors to learn more.

Configure the Amazon EventBridge Connector​

Follow these steps to configure the Amazon EventBridge Connector:

  1. Choose an applicable authentication type from the Authentication dropdown. Learn more about authentication types in the related appendix entry.
  2. In the Authentication section, enter the relevant IAM key and secret pair of the user with permissions to send events to Amazon EventBridge.
  3. In the Configuration section, specify the AWS region where your EventBridge resides.
  4. In the Event Details section, provide the following information:
    • Event bus name: Enter the name of the destination event bus. Refer to the Amazon EventBridge documentation for more details on event buses.
    • Source: Enter the value that identifies the service that generated the event.
    • Detail type: Enter the type of event being sent. Refer to the Amazon documentation for more information on these properties.
  5. In the Event Payload section, enter a JSON object that contains information about the event.
  6. (Optional) In the Output Mapping section, you can set a Result variable or Result expression. Refer to the response mapping documentation to learn more.
  7. (Optional) In the Error Handling section, define the Error expression to handle errors that may occur during the event sending process. Refer to the response mapping documentation to learn more.

Amazon EventBridge Connector response​

The Amazon EventBridge 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
    }
  ]
}

Appendix​

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.

Next steps​