BrinkExternal

Service for outgoing events

Merchant setup

Brinkcommerce is using AWS EvenBridge to send outgoing events AWS documentation. To configure the setup merchants needs to run the provided cloudformation template:

AWSTemplateFormatVersion: "2010-09-09"
Description: Brink Commerce External Events EventBridge
Parameters:
  BrinkCommerceAccountId:
    Description: Account ID (provided by Brink Commerce)
    Type: String
  EventBusName:
    Description: Name of the EventBus to create
    Default: BrinkCommerceIngest
    Type: String
Resources:
  BrinkCommerceIngest:
    Type: AWS::Events::EventBus
    Properties:
      Name: !Ref EventBusName
  AllowEventsPolicy:
    Type: AWS::Events::EventBusPolicy
    Properties:
      EventBusName: !Ref BrinkCommerceIngest
      StatementId: !Sub BrinkPutEvents-${EventBusName}
      Statement:
        Effect: Allow
        Principal:
          AWS:
            - !Ref BrinkCommerceAccountId
        Action: events:PutEvents
        Resource:
          - !GetAtt BrinkCommerceIngest.Arn
        Condition:
          ArnEquals:
            aws:PrincipalArn: !Sub arn:${AWS::Partition}:iam::${BrinkCommerceAccountId}:role/ExternalEvents-ExternalTarget-${EventBusName}

Outputs:
  EventbusArn:
    Description: Eventbus Arn (send back to Brink Commerce)
    Value: !GetAtt BrinkCommerceIngest.Arn

This will create an eventBus with permissions for Brinkcommerce AWS account to send events.

The output EventBusArn should be sent to Brinkcommerce for setup of the events

The supported events can be found here

Last updated on 2024/11/15