Notifications API

• Real-Time Issue Detection – Receive instant notifications when asset deliveries fail or offer statuses change, enabling you to address problems immediately instead of discovering them hours or days later through manual checks.
• Reduced API Overhead – Eliminate the need for continuous polling of status APIs, reducing your infrastructure costs and API call volume while still maintaining up-to-date information.
• Automated Workflow Integration – Connect notifications directly to your existing systems (AWS services or webhooks) to trigger automated responses, ticket creation, or alerting workflows without manual intervention.
• Comprehensive Event Coverage – Monitor both asset delivery status and offer availability across all your titles and territories from a single notification system.

Getting started with notifications requires three steps:

1. Register a Target: Set up where you want to receive notifications. You can choose from AWS services (SQS, SNS, EventBridge) or HTTPS webhooks.
2. Create Subscriptions: Map the events you want to monitor to your registered targets. Each subscription covers one topic (AssetStatus or OfferStatus), but you can subscribe to multiple event types within that topic.
3. Receive Notifications: Once configured, you’ll automatically receive notifications as events occur in real-time.

This section provides technical specifications for developers to integrate the Partner Notification API into your systems. Use this reference to understand the request format, response structure, and data types returned by the API.

Base URL
All API requests are made to the following base URL. Append the relevant endpoint path to this URL when making requests.

A target is the destination where you want to receive notifications—this can be an AWS service (SQS, SNS, or EventBridge) or an HTTPS webhook endpoint. You must register at least one target before creating subscriptions.

Register Target

POST

Create a new notification target where you’ll receive event notifications.

Request Body:

Response:

List All Targets

Use this endpoint to retrieve a full list of the notification targets registered for your organization. This is useful for auditing your current configuration or identifying target IDs to use when creating or updating subscriptions.

GET

Retrieve all registered targets for your organization.

Get Specific Target

GET

Retrieve details for a specific target.

Update Target

PUT

Update an existing target configuration.

Delete Target

DELETE

Remove a target from your configuration.

A subscription maps one or more events to a registered target, determining which notifications you receive and where they are delivered. Each subscription is scoped to a single topic, but you can create multiple subscriptions to cover all the events relevant to your workflow.

Create Subscription

POST

Create a subscription to map events to your targets.

Request Body:

Response:

List All Subscriptions

GET

Retrieve all subscriptions for your organization.

Update Subscription

PUT

Update an existing subscription configuration.

Delete Subscription

DELETE

Remove a subscription from your configuration.

Topics group related events together. When you create a subscription, you select a topic and specify which events within that topic you want to monitor. Each topic maps to a specific area of content status tracking.

• LiveStatusUpdated – When live status changes
• OfferStatusUpdated – When offer status changes (Coming Soon)
• AssetStatusUpdated – When asset status changes (Coming Soon)

Target types define how Prime Video delivers notifications to your systems. You can choose from AWS-managed services for reliable, scalable delivery, or configure an HTTPS webhook to receive notifications directly at your own endpoint.

AWS Targets (SQS, SNS, EventBridge) - Required Fields:

• destination – ARN of AWS resource
• assumeRoleArn – IAM role for delivery
• externalId – Security identifier (optional but recommended)

SQS Example:

SNS Example:

EventBridge Example:

Webhook Targets - Bearer Token:

Webhook Targets - API Key:

Webhook Targets - HMAC (Recommended):

Webhooks receive HTTP POST requests with the following payload:

Authentication Headers:

• HMAC: X-Signature: {signature}
• API Key: X-API-Key: {key}
• Bearer: Authorization: Bearer {token}

When a request cannot be completed, the API returns a structured error response to help you identify and resolve the issue. The response includes an error code and a human-readable message describing the problem.

Common Error Codes:

• BAD_REQUEST – Invalid request parameters
• UNAUTHORIZED – Authentication failed
• NOT_FOUND – Resource not found
• CONFLICT – Resource already exists

If you are using an AWS service (SQS, SNS, or EventBridge) as your notification target, you must configure an IAM Delivery Role to grant Prime Video permission to deliver notifications to your AWS resources. Follow the steps below to set up the required IAM role and permission policies before registering your target.

Prerequisites

• AWS destination resource (SQS Queue, SNS Topic, or EventBridge Bus)
• IAM Delivery Role with trust and permission policies

IAM Role Setup

1. Create Role: AWS Console → IAM → Roles → Create Role → Custom Trust Policy

2. Trust Policy

3. Permission Policy (choose one of the following)

SQS:

SNS:

EventBridge:

The following sections provide answers to common questions about working with the Notifications API.