Client Communications Integration
Learn how to manage Rampart communications from your application
Rampart provides notification API endpoints that you can seamlessly integrate into your application. This guide covers how to implement, display, and manage Rampart notifications to enhance both developer workflow and user experience.
Overview
The Rampart notification system helps you keep clients informed about savings opportunities, contract status changes, and account updates. A well-implemented notification system improves user engagement and ensures clients don’t miss important information.
Notification Types
Rampart offers several categories of notifications, each serving a specific purpose:
Notification Type | Description | Recommended Actions | Call to Action | Rampart’s Message |
---|---|---|---|---|
CLIENT_POTENTIAL_SAVINGS_DETECTED | Triggered when new savings opportunities are identified | Highlighted notification with badge/alert | View Savings | [X]% potential savings available on your [Vendor] spend |
CLIENT_SAVINGS_ANALYSIS_COMPLETED | Sent when initial savings analysis is complete | Display prominently, encourage client to review savings analysis on Rampart | View Savings | [Vendor] spend analyzed. $[Y] (X)% potential savings found on your [Vendor] spend. |
CLIENT_SAVINGS_ANALYSIS_COMPLETED_FOLLOW_UP | Follow-up notification when savings analysis is complete (after 1, 3 and 5 days) | Display prominently, encourage client to review savings analysis on Rampart | View Savings | [Vendor] spend analyzed. $[Y] (X)% potential savings found on your [Vendor] spend. |
CLIENT_CONTRACT_OPT_IN_REQUESTED | Client needs to review and opt-in to new contract | Notification confirming the request has been received | - | Negotiated pricing request sent to [Vendor] No further action required. We will let you know once [Vendor] approves your request. |
CLIENT_CONTRACT_OPT_IN_SUCCESSFUL | Confirms successful contract opt-in | Notification confirming the opt-in has been received and redirecting to the vendor profile on Rampart | - | Negotiated pricing request approved [Vendor] has agreed to move you to our negotiated pricing agreement. Your purchasing process with [Vendor] remains the same: negotiated pricing will be loaded to your account automatically. |
CLIENT_MONTHLY_SAVINGS_REPORT | Monthly summary of realized/potential savings through Rampart | Notification redirecting to the Rampart savings report | View Savings | Last 30 days savings on [Vendor]: $[Savings] |
CLIENT_VENDOR_PASSWORD_UPDATE | Required vendor password updates | Alert notifying the client that the vendor password needs to be updated in order for Rampart to keep tracking their spend | Update Password | - |
Working with Notifications
You can use the following endpoints to integrate Rampart’s notification into your application:
- List Notifications - Retrieve a paginated list of notifications for a client with optional filtering.
- Mark as Read - Mark one or multiple notifications as read to update their status. We also provide a bulk endpoint to mark all notifications as read.
Refer to the API reference for detailed implementation examples and parameter options.