Overview
The EPISHIP Activities API lets you retrieve and monitor system events, notifications, and audit logs associated with your shipping accounts. You can develop applications that integrate with EPISHIP to automate the monitoring of account changes, track user actions, and synchronize unread alerts with your internal dashboards.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Activity services.
Figure 1. EPISHIP API relationship diagram. Activities architecture and data flow.
EPISHIP App
EPISHIP’s activity services give users visibility into the operational history of their workspace, providing a centralized feed for tracking account updates, credit adjustments, and report generation statuses.
EPISHIP API
The REST API that allows users to access activity logs, filter by unread status, and manage notification states programmatically from within your app.
Authentication
A secure method utilizing Bearer tokens in the Authorization header (`Bearer {API_TOKEN}`) to validate requests, ensuring that only authorized users can view sensitive audit trails.
Activity Management
A system that maintains a chronological listing of system events, allowing for the filtering of unread items, pagination of results, and organization by company context or search query.
What can users do with the EPISHIP Activities API?
Users can use the EPISHIP Activities API to perform common workflows, such as:
- Retrieve a listing of unread activities for a specific company
- Mark a batch of activities as read using their IDs
- Filter activity logs by page, rows per page, and sort order
- Search for specific activities using the query parameter
- Audit specific events like “update-account” or “create-report-schedule”
- Retrieve the full details of a single activity by ID
Activity properties available to view and filter through the EPISHIP Activities API:
- Activity ID
- Type (e.g., update-account, selected-account-holders)
- Level (e.g., success, info)
- Message Content
- Logged User Details
- Timestamps (Created/Updated)