AWS SQS Callbacks

The HH Data Management server can send information to an AWS SQS queue to facilitate integration with external applications.  To define such an integration visit the Integrations section on the website:

After clicking "Add New SQS Callback" some information for the SQS queue will need to be entered:

  • Name: a name to identify the callback.
  • Description: any further information that should be recorded for the callback.
  • IAM Access Key: the HH Data Management server needs an IAM identity with access to the target SQS queue.  Enter the access key for this IAM user in this field.
  • IAM Secret Key: the HH Data Management server needs an IAM identity with access to the target SQS queue.  Enter the secret key for this IAM user in this field.
  • AWS Account ID: the AWS account ID that owns the SQS queue (this is required to build the SQS queue URL).
  • Region Name: the AWS region where the SQS queue is hosted (this is required to build the SQS queue URL).
  • Queue Name: the name of the target SQS queue (this is required to build the SQS queue URL).
  • Message Filter: a semi-colon separated list of HH Data Management messages that should be added to the SQS queue.  An example might be AddSetupMessage;UpdateSetupMessage;DeleteSetupMessage if a queue should be notified of any changes to setups.  If this field is left blank then all messages will be added to the SQS queue.

An example of the content that would be added to the SQS queue is:

{
  "MessageType": "UpdateSetupMessage",
  "ItemId": "0adf0ecf-389e-4dfe-9af4-96ff90aab4ad",
  "Payload": {
    "CustomPropertyDefinitionId": "71d5a9b2-7e9a-42c2-abe3-f9add1ec2bb4",
    "CustomProperties": [
      {
        "CustomPropertyType": 0,
        "Name": "CamberFL",
        "Value": "5"
      }
    ],
    "CollectionItemsAdded": [],
    "CollectionItemsUpdated": [],
    "CollectionItemsDeleted": [],
    "CollectionOrderUpdates": [],
    "EntityProperties": [
      {
        "Name": "LastModifiedBy",
        "Value": "5a808284-6fb7-47a6-95b3-e199600e05dd"
      },
      {
        "Name": "LastModifiedDate",
        "Value": "2021-01-17T15:11:15Z"
      }
    ]
  }
}

Still need help? Contact Us Contact Us