Notification subscriptions
A person's choice to follow or mute updates for one business item.
- API name:
notificationsubscriptions - Domain: Notifications
- Modules: My workspace
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| User | userId | User | Yes | |
| Table | tableUid | Constant | Yes | Business table this row points to. |
| Record | recordId | Text | Yes | |
| Module | moduleUid | Constant | Yes | Product module that owns or scopes this row. |
| Followed at | subscribedAt | Date and Time | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
User userId | Users | reference |
Actions
What you can do with a record. Every action also sends the webhook event notificationsubscriptions.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new subscription. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this subscription. | App · WebMCP · API · MCP · CLI |
| Subscribe | subscribe | Subscribe to notifications for this subscription. | App · WebMCP · API · MCP · CLI |
| unsubscribe | unsubscribe | Apply to one record. unsubscribe. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this subscription and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.
| Action | API name |
|---|---|
| Subscribe | subscribe |
| unsubscribe | unsubscribe |