API destinations route events from EventBridge to any HTTP endpoint -- a third-party SaaS platform or your own service -- in a low-code way and without extra architectures. Each API destination pairs with a connection that stores authentication credentials. Configure credentials once in a connection, then reuse that connection across multiple API destinations and event rules.
When you update an API destination, every event rule that references it picks up the change automatically -- no need to edit rules individually.
How API destinations and connections work
An API destination defines *where* to send events: the HTTP endpoint URL and request method. A connection defines *how* to connect and authenticate: the network configuration and the credential type and parameters.
This separation provides two advantages:
Reusable authentication. One connection can serve multiple API destinations that share the same authentication method. If API destinations require different authentication, create separate connections.
Centralized endpoint management. Changes to an API destination propagate to all event rules that reference it.
Authentication methods
Connections support three authentication methods:
| Method | How it works | When to use |
|---|---|---|
| Basic | EventBridge Base64-encodes the username and password, adds a Basic prefix, and sends the value in the HTTP Authorization header. The destination service decodes and verifies the credentials before responding. | The target API uses HTTP Basic authentication. |
| OAuth Client Credential | EventBridge requests an access_token from an OAuth endpoint using a client ID and client secret, then includes the token in subsequent requests. OAuth supports four grant types: authorization code, implicit authorization code, password, and client credential. In event-driven scenarios, client credentials are commonly used. Supports GET and POST methods for the token request. | The target API uses OAuth 2.0 client credentials flow. |
| API Key | EventBridge sends a custom key-value pair in the HTTP header for each request. | The target API authenticates with a static API key. |
Prerequisites
Before you begin, make sure that you have:
Create a connection
A connection stores authentication credentials for one or more API destinations. Create a connection before or while creating an API destination.
Log on to the EventBridge console. In the left-side navigation pane, choose Integration Center > API Destination.
In the top navigation bar, select the region where you want to create the connection.
Click the Connection Configuration tab, then click Create.
In the Create Connection panel, configure the following parameters and click OK.
| Parameter | Description | Example |
|---|---|---|
| Name | The connection name. | testName |
| Description | A brief description of the connection. | test |
| Authentication | The authentication method. Valid values: Basic, OAuth Client Credential, API Key. | Basic |
| Username | The username for Basic authentication. Required when Authentication is set to Basic. | Admin |
| Password | The password for Basic authentication. Required when Authentication is set to Basic. | ****** |
| Endpoint | The URL used to obtain an access_token. Required when Authentication is set to OAuth Client Credential. | https://postman-echo.com/oauth1 |
| HTTP Method | The request method used to obtain an access_token. Required when Authentication is set to OAuth Client Credential. | POST |
| Client ID | The client ID used to obtain an access_token. Required when Authentication is set to OAuth Client Credential. | Admin |
| ClientSecret | The client secret. Required when Authentication is set to OAuth Client Credential. | ****** |
| OAuth HTTP Parameter | Additional headers, body parameters, or query parameters to include in the access_token request. Required when Authentication is set to OAuth Client Credential. | Parameter: Header, key: name, Value: eventbridge |
| ApiKeyName | The key name for API Key authentication. Required when Authentication is set to API Key. | Admin |
| ApiKeyValue | The key value for API Key authentication. Required when Authentication is set to API Key. | ****** |
| Network | The network type. Default value: Internet. | Internet |
Create an API destination
Log on to the EventBridge console. In the left-side navigation pane, choose Integration Center > API Destination.
In the top navigation bar, select the region where you want to create the API destination.
Click the API Destination tab, then click Create.
In the Create API Destination panel, configure the following sections and click OK:
Basic Information: Set Method to Custom, then specify the name and description of the API destination.
API Configuration: Set URL to the API endpoint of the target service, and set HTTP Method to the request method (for example, GET or POST).
Connection Configuration: Choose one of the following options:
Create Connection -- Configure a new connection by following the steps in Create a connection.
Select Existing Connection -- Select an existing connection from the drop-down list.
Use an API destination as an event target
After you create an API destination, reference it as a target in an event rule to route matching events to the destination endpoint.
Log on to the EventBridge console. In the left-side navigation pane, click Event Buses.
In the top navigation bar, select a region. Click the name of the event bus that you want to manage.
In the left-side navigation pane, click Event Rules, then click Create Rule.
In the Create Rule panel, complete the following steps and click Create:
On the Configure Basic Info and Configure Event Pattern tabs, configure the event rule. For details, see Create an event rule.
In the Configure Targets step, select Triggered by API Operation from the Service Type drop-down list.
To create a new API destination inline, select Custom for Method and configure the settings as described in Create an API destination.
To use an existing API destination, select Use Existing Item for Method and choose the API destination from the drop-down list.
Manage connections
After you create a connection, view, edit, or delete it from the Connection Configuration tab.
| Operation | Steps |
|---|---|
| View details | Click Details in the Actions column to view the basic information, authentication configuration, network configuration, and bound API destinations. |
| Edit | Click Edit in the Actions column to modify the connection description. |
| Delete | Click Delete in the Actions column. Read the confirmation message and click OK. |
Manage API destinations
After you create an API destination, view, edit, or delete it from the API Destination tab.
| Operation | Steps |
|---|---|
| View details | Click Details in the Actions column to view the basic information, API configurations, and connection configurations. |
| Edit | Click Edit in the Actions column to modify the description and API configurations. |
| Delete | Click Delete in the Actions column. Read the confirmation message and click OK. |