Amazon SQS Broadcaster Setup Guide

Introduction

This guide provides detailed instructions for configuring and setting up the Amazon SQS Broadcaster feature. This feature allows you to broadcast platform events to your Amazon SQS queues.

Steps to Configure Amazon SQS Broadcaster

Step 1: Accessing Amazon SQS Broadcaster

To access the Amazon SQS Broadcaster:

1. Log in to the Fynd Partner Panel.
2. Navigate to Extensions and select the desired extension.
3. Under the selected extension, click on Webhook.
4. Click on Add Configuration.
5. From the list of broadcaster types, select Amazon SQS.
6. You will be directed to the Amazon SQS Config page.

Step 2: Configuring Amazon SQS Broadcaster

Provide the following details:

• Name: Provide a unique name to identify this broadcaster configuration.
• AWS Access Key: Enter the AWS Access Key ID for the IAM user with the necessary permissions. This key is used to authenticate API requests
• AWS Access Secret: Enter the AWS Access Secret Key associated with your Access Key ID. Ensure this is kept confidential as it grants access to your AWS resources.
• AWS AWS Region: Specify the AWS region where the broadcaster events will be handled (e.g., us-east-1, eu-west-1).
• AWS Account ID: (Optional) Enter your AWS Account ID if required.

Explanation of Fields:

• AWS Access Key and AWS Access Secret: Credentials for AWS authentication.
• AWS Region: The geographical region of your SQS service.
• AWS Account ID: Your unique AWS account identifier.

Step 3: Validation

1. Click on Validate.
2. The platform will verify the provided AWS credentials and attempt to connect to Amazon SQS.
3. Upon successful validation, a confirmation message will appear.
4. Click on Save to complete the configuration.

A pop-up will appear indicating Validation Successful if the entered details are valid.

Step 4: Create SQS Subscriber API:

1curl --location 'https://{{host}}/service/platform/webhook/v2.0/company/1/subscriber' --header 'Content-Type: application/json' --header 'Authorization: {{Bearer Token}}' --data-raw '{
2    "name": "sqs subscriber",
3    "provider": "sqs",
4    "association": {
5        "company_id": 1,
6        "criteria": "ALL",
7        "extension_id":"6684c91938568e58638a2b42"
8    },
9    "custom_headers": {},
10    "status": "active",
11    "email_id": "[email protected]",
12    "auth_meta": {},
13    "events": [
14        {
15            "slug": "company/article/update/v1",
16            "queue": "test-queue"
17        }
18    ]
19}'