EPISHIP API Notifications overview

EPISHIP Notifications API icon 32px svg

Overview

The EPISHIP Notifications API allows you to programmatically retrieve and manage user alerts and system notifications. You can develop applications that integrate these notifications into custom dashboards, ensuring users are immediately aware of critical events like successful payments, credit top-ups, or system updates.

View Doc →

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Notification services.

EPISHIP Notifications API diagram

Figure 1. EPISHIP API relationship diagram. Notification generation and retrieval flow.

EPISHIP App

EPISHIP’s notification center provides a unified feed of important account activity. It serves as the primary communication channel for automated system messages, keeping users informed about billing events, job completions, and other actionable items.

EPISHIP API

The REST API that exposes user notifications. It supports retrieving both read and unread messages, marking specific notifications as read in bulk, and fetching detailed information for individual alerts.

Authentication

Secured via Bearer tokens in the Authorization header. Notifications are scoped strictly to the authenticated user, ensuring that private alerts and account-specific messages are never exposed to unauthorized parties.

What can users do with the EPISHIP Notifications API?

Users can use the EPISHIP Notifications API to perform common workflows, such as:

  • Retrieve a paginated list of unread notifications to display in a “bell” icon or dashboard widget
  • Fetch a complete history of all notifications, including those already read
  • Get detailed properties of a specific notification ID, including success/failure levels and icons
  • Mark a batch of notifications as read using their IDs to keep the user’s feed clean

Notification properties available to view and filter through the EPISHIP Notifications API:

  • Notification ID (UUID)
  • Type (e.g., DbNotification)
  • Title and Message
  • Level (success, warning, error)
  • Icon (e.g., account_balance)
  • Read At Timestamp
  • Created At Timestamp

Additional info

  • Learn more about developing with EPISHIP Notifications API, including handling authentication, authorization, reference the Develop on EPISHIP API for your workspace. More
  • Learn more about how to launch and run an EPISHIP Notifications API app, read the Developer Page. More →

Related

Related Categories