Skip To Main Content
All modules

Notifications

Fields marked * are required. Updates keep every field they are not given. An AI app can ask vritto_describe for the same details, filtered to what its connection may use.

Notificationnotification

An item in the user's Vritto inbox.

notifications_findNotificationsBySourceFindthrough vritto_find

Finds notifications created for a specific module entity, e.g. all reminders attached to one calendar event.

FieldTypeDescription
source*objectModule entity this notification originates from.
source.moduleId*stringModule that owns the source entity, e.g. 'calendar'.
source.entityId*stringID of the entity the notification is about.
limitintegerMax results (default 25).
notifications_getNotificationFindthrough vritto_find

Fetches one notification by ID.

FieldTypeDescription
notificationId*stringNotification ID.
notifications_getUnreadNotificationCountFindthrough vritto_find

Returns the unread notification count, optionally scoped to specific modules.

FieldTypeDescription
moduleIdslist of stringRestrict to notifications from these modules (unique, max 10).
notifications_listNotificationsFindthrough vritto_find

Lists inbox notifications, newest first, with optional filter, module scoping, and cursor pagination.

FieldTypeDescription
filterone of all, unread, reminder, system, archivedInbox filter. Defaults to all (non-archived).
moduleIdslist of stringRestrict to notifications from these modules (unique, max 10).
limitintegerMax results (default 50).
cursorstringPagination cursor: the nextCursor value from a previous page.
notifications_createNotificationCreatethrough vritto_create

Creates an immediate notification in the user's inbox. Requires a stable idempotencyKey so retries do not duplicate. Use scheduleNotification instead when the user wants a future reminder.

FieldTypeDescription
notification*objectNotification to create. scheduledFor is ignored; delivery is immediate.
notification.idstringExplicit notification ID. Usually omitted so one is generated.
notification.title*stringNotification title.
notification.bodystringNotification body.
notification.category*one of reminder, update, system, warning, successNotification category.
notification.priorityone of low, normal, high, criticalNotification priority. Defaults to normal.
notification.sourceobjectModule entity this notification originates from.
notification.actionobjectOptional tap-through action.
notification.requestedChannels*list of one ofRequested delivery channels; unique, 1-3 entries.
notification.idempotencyKey*stringStable dedupe key. Re-sends with the same key are merged.
notification.scheduledForstringWhen to deliver. Omit for immediate delivery.
notification.metadatalist of objectOptional string metadata entries, at most 20. The 'intent' key is special: cancelNotificationsBySource's intent filter matches against metadata.intent.
notifications_archiveNotificationUpdatethrough vritto_update

Archives one notification, removing it from the active inbox.

FieldTypeDescription
notificationId*stringNotification ID.
notifications_markAllNotificationsReadUpdatethrough vritto_update

Marks all unread, non-archived notifications as read (up to 500 at a time).

No input.

notifications_markNotificationReadUpdatethrough vritto_update

Marks one notification as read.

FieldTypeDescription
notificationId*stringNotification ID.
notifications_markNotificationUnreadUpdatethrough vritto_update

Marks one notification as unread.

FieldTypeDescription
notificationId*stringNotification ID.
notifications_snoozeNotificationUpdatethrough vritto_update

Snoozes a notification until a future time and marks it unread so it resurfaces.

FieldTypeDescription
notificationId*stringNotification ID.
until*stringFuture time when the notification should resurface.
notifications_cancelNotificationDeletethrough vritto_delete

Cancels a notification (including scheduled ones) and archives it. Use only for explicit cancellations.

FieldTypeDescription
notificationId*stringNotification ID.
notifications_cancelNotificationsBySourceDeletethrough vritto_delete

Cancels and archives every notification tied to a module entity, optionally narrowed by metadata intent. Use for bulk cleanup when the underlying entity changed.

FieldTypeDescription
source*objectModule entity this notification originates from.
source.moduleId*stringModule that owns the source entity, e.g. 'calendar'.
source.entityId*stringID of the entity the notification is about.
intentstringOnly cancel notifications whose metadata.intent matches.

Kept in the Vritto app

  • notifications_scheduleNotification: Reaches outside Vritto: another service, a device, or the public web.
  • notifications_rescheduleNotification: Reaches outside Vritto: another service, a device, or the public web.
  • notifications_dispatchMyNotificationsNow: Reaches outside Vritto: another service, a device, or the public web.
  • notifications_registerPushDevice: Reaches outside Vritto: another service, a device, or the public web.
  • notifications_getNotificationPreferences: Changes or reads app-wide settings, which belong in the app.
  • notifications_setModuleNotificationPreference: Changes or reads app-wide settings, which belong in the app.
  • notifications_setModuleNotificationCategoryPreference: Changes or reads app-wide settings, which belong in the app.
  • notifications_ensureNotificationsFoundation: Background upkeep Vritto already runs on its own.
  • notifications_getNotificationDeliverySummary: Background upkeep Vritto already runs on its own.
  • notifications_getPushDeviceStatus: Background upkeep Vritto already runs on its own.
  • notifications_removePushDevice: Background upkeep Vritto already runs on its own.