# Receive events in EventBridge

[Amazon EventBridge](https://aws.amazon.com/eventbridge/) is a serverless service that enables you to build event-driven applications through asynchronous communication between Amazon Web Services (AWS) and third-party applications.

> **Information**
>
> To enable the EventBridge event source, contact your account manager or [request support](https://dashboard.checkout.com/support/new?topic=case_account_management_and_access&issue=issue_account_changes).

---

## How it works

Checkout.com's EventBridge event source publishes events directly into AWS using a serverless event bus.
This can improve delivery rates and enable more flexible integrations with AWS services.

For example, you can receive events in Amazon Simple Queue Service (SQS) or Amazon Simple Notification Service (SNS).
This removes the need to create and manage a webhook endpoint, and leverages AWS service availability.

Follow these steps:

1. Register a partner event source in EventBridge
2. Associate the event source with an event bus.
3. Create an EventBridge rule.

---

## Register a partner event source

To register a partner event source in EventBridge, call the [Add a workflow](https://api-reference.checkout.com/tag/Workflows/#operation/addWorkflow) endpoint and provide the following:

- `actions[].account_id` – Your AWS account ID.
- `actions[].region` – The AWS region that the services that consume from the EventBridge connection are located in.
- `actions[].type` – Set to `aws`.
- `conditions[].events` – The [events](https://www.checkout.com/docs/developer-resources/event-notifications/event-types.md) to forward to EventBridge.

> **Information**
>
> Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

`POST` `https://{prefix}.api.checkout.com/workflows`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/workflows`

### Request example

```json
{
  "name": "EventBridge Notifications",
  "conditions": [
    {
      "type": "event",
      "events": {
        "gateway": [
          "payment_approved"
        ]
      }
    }
  ],
  "actions": [
    {
      "type": "aws",
      "region": "eu-west-1",
      "account_id": "0000000000000"
    }
  ]
}
```

### Response example

```json
{
  "id": "wf_wlu3wxc26jounofs5iez75qaqa",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/workflows/wf_wlu3wxc26jounofs5iez75qaqa"
    }
  }
}
```

---

## Associate the event source with an event bus

To associate the source with an event bus in EventBridge:

1. Sign in to your AWS Console.
2. Go to the _Amazon EventBridge_ section.
3. Select _Partner event sources_.
4. Find and select the event source that contains the ID of the workflow you created earlier in its URL. For example, `wf_wlu3wxc26jounofs5iez75qaqa`.
5. Select _Associate with event bus_.

  This creates an event bus that you can use in your EventBridge rules.

---

## Create an EventBridge rule

Create a rule to connect your event sources to your target:

1. Sign in to your AWS Console.
2. Go to the _Amazon EventBridge_ section.
3. Select _Rules_ and create a new rule.
4. In _Events_, set _Event source_ to _AWS events or EventBridge partner events_.
5. In _Event pattern_ , set _Event source_ to _EventBridge partners_, and _Partner_ to _Checkout.com_.
6. Select the target to send events to.

  This connects the Checkout.com events you configured to your event target.

> **Information**
>
> If you encounter issues with your integration, contact [notifications-team@checkout.com](mailto:notifications-team@checkout.com).