Skip to main content

How-to: View Toast Notifications

Issue:

Is it possible to view a log of toast ("pop-up") notifications?

Solution:

  • Toasts are a visual element, but depending on what triggered the toast, there may be additional information in either the notifications tray or the backend logs

  • Depending on the toast, the action may be logged separately in the backend

  • Resource actions (History/Audit Log) can also tell a story of what occurred if the action changed a resource

  • When developing custom content extensions for ESP, the toast functions offered from the frontend (api.showNotification(…)) are also visual, but developers can add their own handling to log error events in a persistent location

  • Some tools that developers can use to log events for later review:

    • Notifications API (Bell Icon in Header)

    • Email Integration

    • Structured Logs on the server

Notifications API

  • Users have a notification tray in the header bar (Bell icon) that stores system notifications, and will maintain a counter of notifications not yet marked Read/Acknowledged

  • Standard notifications for all L7|ESP implementations for example include Pipeline completion updates

  • Notifications can be sent to this tray using both the REST API and with backend extensions

  • Using the REST API:

15298819435411-mceclip0.png
15298822983059-mceclip1.png
15298799273107-mceclip2.png
15298851372051-mceclip3.png
  • From a backend extension:

    • Backend extensions such as custom endpoints (invokables.py) can send users notifications with the following function calls:

15298866190355-mceclip4.png