Salesforce Docs Portal

Create an Event Relay

An event relay associates the channel in the Salesforce event bus with Amazon EventBridge using a named credential. The creation of the event relay results in a partner event source being created in Amazon EventBridge. The partner event source is created with a pending status.

Required Editions

User Permissions Needed
To create an event relay: Customize Application
  1. From Setup, in the Quick Find box, enter Event Relays, and then select Event Relays.
  2. In the Event Relays page, click New Event Relay. Use the event relay creation wizard and provide the requested information in each step.
    New event relay button
  3. Enter a label for the event relay, for example, Carbon Comparison Relay. The label appears in the event relays list view and the event relay detail page. Make sure you choose a meaningful name and try to make it unique. The name is auto populated based on the label that you provide.
    Enter a label for the event relay
  4. Select a named credential that contains your AWS account information from the dropdown. To create a named credential, see Create a Named Credential for Event Relay Setup.
    Select a named credential for the event relay
  5. Select a channel that references the events that you want to send to EventBridge from the dropdown. To create a channel, see Create a Channel and Channel Members.
    Select a channel for the event relay
  6. Select an error recovery option. This option is used when the system can't resume from the last relayed event after it recovers from an error. You can keep the default.
    Select an error recovery option for the event relay
  7. Review the summary screen, and save your changes to create the event relay.
    Event relay summary page

After you create the event relay, the event relay detail page contains the Partner Event Source Name field. This field is populated after a short delay with the name of the partner event source that’s created in Amazon EventBridge. Wait and then refresh the detail page to get the partner event source. You use this field value in the next step to find the partner event source in Amazon EventBridge.

The event relay is created in a stopped state, and no events are relayed to Amazon EventBridge. Before starting the event relay, activate the partner event source in Amazon EventBridge. You perform these steps next.