EPISHIP API Notifications overview

EPISHIP Notifications API icon 32px svg

Overview

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:

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

Additional info

Related

Related Categories