Search

Update Notifications

Overview

When Data Inventory records are updated by any source, TrustArc sends notifications to an Amazon AWS Simple Notification Service (SNS) Topic. This allows clients to receive real-time notifications when users make changes via the TrustArc UI. Notifications can be triggered when any field changes, or only when certain specified fields change.

What you can do
✓Receive real-time notifications when Data Inventory records are updated in TrustArc
✓Subscribe your application's HTTPS endpoint to the SNS Topic to receive push notifications
✓Extract the updated record's accountId, internalId, and externalId from the notification payload

📋 Setting up notifications: There are multiple ways to subscribe to the SNS Topic. The recommended approach is to expose a callback HTTPS endpoint in your application. TrustArc staff can configure the subscription for you — you only need to supply the full URL of your endpoint.

Full SNS Message Structure

The full SNS notification message sent to your endpoint will look like this:

Sample SNS Notification
{
  "Type": "Notification",
  "MessageId": "2e8333e5-2a6b-5f61-8ef7-6d9af972f16d",
  "Token": null,
  "TopicArn": "arn:aws:sns:us-west-2:060318674886:queue-name",
  "Subject": "subject:TrustArc Entity Update",
  "Message": "{\"accountId\":\"a3b1ea4f-b9c9-48e7-b13a-d3e7dd2cdf44\",\"internalId\":\"a7caf86c-a15f-4cc2-9409-adce71b1c278\",\"externalId\":null}",
  "Timestamp": "2024-03-28T20:19:37.084Z",
  "SignatureVersion": "1",
  "Signature": "W1Cak/3e0MwuK1bcBhvJ==",
  "SigningCertURL": "https://sns.us-west-2.amazonaws.com/SimpleNotificationService-60eadc530605d63b8e62a523676ef735.pem",
  "UnsubscribeURL": "https://sns.us-west-2.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-west-2:060318674886:colin-queue:631224f7-0356-4538-9b64-d2f335ff8d87",
  "SubscribeURL": null
}

📋 Implementing your HTTPS endpoint: Full instructions for subscribing an HTTPS endpoint to an SNS Topic are available in the AWS documentation:
https://docs.aws.amazon.com/sns/latest/dg/sns-subscribe-https-s-endpoints-to-topic.html

The Message Field

Within the full SNS message is the Message field, which contains the details of the Data Inventory record that was updated. This field is a JSON-encoded string. When parsed, it exposes the following fields:

Parsed Message Payload
{
  "accountId": "a3b1ea4f-b9c9-48e7-b13a-d3e7dd2cdf44",
  "internalId": "a7caf86c-a15f-4cc2-9409-adce71b1c278",
  "externalId": "my-identifier"
}
Message Fields
accountId
The UUID of the TrustArc account that owns the updated record.
internalId
The TrustArc-assigned Internal ID of the updated Data Inventory record. Use this with the Hub API single-record GET endpoints to retrieve the latest record state.
externalId
The External ID assigned to the record by the client system. May be null if no External ID has been set on the record.
TrustArc  ·  Hub API — Update Notifications  ·  support.trustarc.com