Skip to content

New pattern submission- apigw-connect-notification pattern #3288

Description

@vaidehip86

### Description:
Adds the apigw-connect-notification pattern: an API Gateway sends in-app push notifications to Amazon Connect agents and admins through a direct AWS service integration via CreateNotification API.

Level: 200

Framework: SAM

Services: API Gateway, Amazon Connect

What is Amazon Connect Notifications?
In-app notifications are on-screen alerts in the Amazon Connect workspace header. They're the only built-in mechanism to broadcast messages to agents/admins regardless of what page they're on. Currently Notifications can only be sent via the API there is no console UI to compose or send them.

Supported use cases:

  • System notifications: availability impacts, failover events, policy changes, critical feature updates
  • Custom organizational messages: training reminders, schedule adherence alerts, emergency notifications

How it works

  • A POST /notifications REST endpoint accepts a JSON body with recipients, localized content, and optional priority/TTL.
  • API Gateway transforms the request via a VTL mapping template (camelCase → PascalCase) and calls the Connect CreateNotification API directly using a PUT integration.
  • An IAM role grants API Gateway the connect:CreateNotification permission. No Lambda function sits in between.
  • Notifications appear in the Connect header for targeted users within seconds.

Resources

Author bio may include a LinkedIn and/or Twitter reference and a 1-sentence bio. :

"name": "Vaidehi Patel",
"bio": "Solutions Architect at Amazon Web Services",
"linkedin": "https://www.linkedin.com/in/vaidehi-patel08/"

You must ensure that the sections of the model README.md are completed in full.

GitHub PR for template:

#3287

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions