Adapter - Amazon SQS Webhook
This page describes version 2.0.8 of the adapter.
Overview
This adapter uses the Amazon Web Service Simple Queue Service API (Amazon SQS) to receive messages from SQS and triggers a webhook on the Integration platform.
The name of the webhook should be passed in the message with the key "webhookname". The message body should be within the "body". Below is an example of a JSON message.
{"webhookname":"mywebhook","body":{"userid":"test", "password":"test"}}
A valid AWS account is needed to use this adapter. Please refer to Amazon's Documentation for help configuring a queue.
Currently this adapter is limited to a 256K message payload. If your use case needs large payload it is possible by using an AWS S3 bucket. Please contact your NEC support center if you need the larger payloads.
Configuration
All of the Amazon adapters, require a region, accessKey and secretKey. The regions list can be found in Amazon's documentation. The accessKey and secretKey are accessed by logging in to your amazon account.
Accessing Secret Key
The secretKey can only be accessed once, directly after the accessKey and secretKey are generated.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| queueRegion | Queue Region | True | The Amazon (AWS) region to run the commands on for the SQS. | string | us-west-1 | 1024 | 1 | ||
| accessKey | Access Key | True | The Amazon account's Access Key. | password | 1024 | 1 | |||
| secretKey | Secret Key | True | The Amazon account's Secret Key. | password | 1024 | 1 | |||
| queueUrl | Queue Url | True | The Amazon queue URL. | string | 1024 | 1 | |||
| bucketRegion | Bucket Region | False | The Amazon (AWS) region to run the commands on for the S3 Bucket. | string | us-west-1 | 1024 | 1 | ||
| bucketName | The name of the S3 Bucket | False | The Amazon S3 Bucket | string | 1024 | 1 |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |
| 2.0.8 | Maintenance | Updated third-party components and improved maintainability. | NAP-27635 | 2024-07-31 |