For the complete documentation index, see llms.txt. This page is also available as Markdown.

Portfolio Notifications

Used by the Portfolio LTI tool to emit a Canvas notification for a recipient user. This does not persist a domain record; it dispatches the shared "Portfolio Event" notification through the standard pipeline (respecting the recipient's /profile/communication preferences and daily/weekly digest for the "Portfolio" category), carrying the per-event copy in the message data hash -- the same approach other data-only notifications (e.g. 2fa) use.

The notification is recipient-scoped, not course-scoped. Authorization is a shared-context check: the caller may only notify someone Canvas already considers messageable from them (they share a course/group) -- the same rule Conversations uses to decide who you can message.

Create a portfolio notification

PortfolioNotificationsController#create

POST /api/v1/users/:user_id/portfolio_notifications

Scope: url:POST|/api/v1/users/:user_id/portfolio_notifications


This documentation is generated directly from the Canvas LMS source code, available on Github.

Last updated

Was this helpful?