Skip to main content

Callback Delivery

Callbacks are the mechanism by which Vantor notifies customers of events that occur during the processing of their tips, watchboxes, etc. Most callbacks are self-contained and provide a status update with some related metadata. When data is being delivered, however, as with the Products_Available and Full_Strip_Available callbacks, they utilize the following paradigm.

  • The callback payload contains a URL reference to a delivery manifest hosted in S3 and fronted by CloudFront with an obscured URL.
  • The customer can fetch that delivery manifest with a simple HTTP GET request and no auth required.
  • The delivery manifest contains a list of files that are ready for download, again hosted in S3 and fronted by CloudFront with obscured URLs.
  • The customer can iterate over each file in the delivery manifest and download it with a simple HTTP GET request and no auth required.

Callback Delivery Options​

There are several ways to receive callback messages from Vantor. Multiple options can be used simultaneously.

S3 Bucket Delivery (Default)​

  • Callback payloads are written to a Vantor-hosted S3 bucket
  • Customer has permissions to monitor for new callback payloads arriving
  • Products_Available and Full_Strip_Available callbacks include URLs and S3 paths pointing to delivery manifests
  • Delivery manifests contain CloudFront URLs for downloading files via HTTPS

Access options:

  • Customer provides an AWS IAM role, or
  • Vantor provisions an IAM user

In either case, the customer assumes a Vantor-managed customer-specific AWS IAM role for interacting with S3. This is not required if the customer is receiving callbacks via some other mechanism below and following the links to the delivery manifest. S3 permissions are only needed if a customer wishes to monitor the S3 bucket for new callbacks.

SNS Notifications (Optional)​

  • Subscribe to a Vantor-managed SNS topic to monitor for new callbacks arriving in S3

REST Callback (Optional)​

  • Callback sent to a customer-managed endpoint
  • Supported authentication: API key, OAuth2

Email Notifications (Optional)​

  • Callback sent via email to configured email addresses