Docs Reference

Notifications

Read notifications and mark them read.

soontra_notifications_list

  • Scope read
  • Read-only

YOUR notifications in this workspace (mentions, assignments, updates) - the credential owner's, not the whole workspace's. filter: 'unread' | 'mentions'. Actor names appear only when the directory scope is granted.

Parameters of soontra_notifications_list
ParameterTypeDescription
filter"unread" | "mentions"
limitinteger1 to 50

Returns The credential owner's notifications (id, type, title, body, project_id, is_read, read_at, created_at) with count and unread_count.

  • limit defaults to 20, maximum 50, and there is no paging.
  • actor_id and actor_name are included only with the directory scope.

soontra_notifications_markAllRead

  • Scope write
  • Writes

Mark ALL of your unread notifications in this workspace as read.

Parameters of soontra_notifications_markAllRead
ParameterTypeDescription
idempotency_keystringUnique key for this logical mutation. Reuse only to retry the exact same payload. 1-128 chars: A-Z a-z 0-9 _ . : -

Returns A receipt: marked_all_read: true.

soontra_notifications_markRead

  • Scope write
  • Writes

Mark one of your notifications read (or unread with read: false).

Parameters of soontra_notifications_markRead
ParameterTypeDescription
notification_idrequiredstring (uuid)
readboolean
idempotency_keystringUnique key for this logical mutation. Reuse only to retry the exact same payload. 1-128 chars: A-Z a-z 0-9 _ . : -

Returns The notification id with read_at and is_read.

  • read: false marks it unread again.