Amazon EventBridge connector

Send events from your BPMN process to an Amazon EventBridge event bus 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 publish events from your processes, which EventBridge rules can then route to other AWS services or API destinations. For example, use it to publish an order-created event that triggers a fulfillment rule in EventBridge.

To receive events from Amazon EventBridge and start or continue a process, 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. They aren't required if you use the default credentials chain (hybrid/Self-Managed only) or a saved AWS credential.

note

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.

Use an outbound connector

Configuration

Authentication

Property	Type	Required	Description	Example
AWS credential	Configuration	No	Select a saved AWS credential, which can include a default region. When you select a credential, the Authentication, Access key, and Secret key fields are hidden. Learn more about credentials.
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.	Credentials
Access key	String	Yes	IAM access key of a user with permission to send events to Amazon EventBridge. Shown when Authentication is Credentials and no AWS credential is selected.	{{secrets.MY_AWS_ACCESS_KEY}}
Secret key	String	Yes	IAM secret key of a user with permission to send events to Amazon EventBridge. Shown when Authentication is Credentials and no AWS credential is selected.	{{secrets.MY_AWS_SECRET_KEY}}

Region

Property	Type	Required	Description	Example
Region	String	Yes	The AWS region where your EventBridge resides. When you select an AWS credential, this field is optional: it overrides the credential's default region, and is required if the credential has no default region.

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 EventBridge documentation for more information.
Detail type	String	Yes	The type of event being sent. Refer to the Amazon EventBridge documentation for more information.
Event payload	String	Yes	A JSON object that contains information about the event. Refer to the Amazon EventBridge event structure documentation for more information.

Output

The connector returns the original response from the Amazon EventBridge service, including the sdkResponseMetadata and sdkHttpMetadata. For example:

{
  "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 event ID into a process variable, use Result expression:

= {
  "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
• Amazon EventBridge Webhook connector