Notification objects have a polymorphic structure. They can be of various types and each type has a certain set of actions that describe the notification further. Notification content (specifically `resource` and `context` fields) varies based on the value of type field. These variations and their details are described in the table below. Type | Actions | Context | Resource | Description --| --| --| --| -- `workspace.project` | `activated`
`archived`
`deleted`
`ownership_transferred` | - | `Project (extra: { name, platform })` | Used for changes related to projects in a workspace. `workspace.styleguide` | `activated`
`archived`
`deleted`
`ownership_transferred` | - | `Styleguide (extra: { name, platform })` | Used for changes related to styleguides in a workspace. `workspace.organization.member` | `role_updated`
`invited` | `Organization (extra: { name })` | `OrganizationMember (extra: { role })` | Used for changes related to members of a workspace. `project.screen` | `created`
`version_created`
`deleted` | `Project (extra: { name, platform })`
`ScreenVersion (extra: { image_url, thumbnails, width, height })` | `Screen (extra: { name })` | Used for changes related to screens in a project. `project.screen.note` | `created`
`mentioned` | `Project (extra: { name, platform })`
`Screen (extra: { name })`
`ScreenNoteComment (extra: { content })` | `Screen (extra: { order, color, status })` | Used for changes related to notes. `project.screen.note.comment` | `created`
`mentioned` | `Project (extra: { name, platform })`
`Screen (extra: { name })`
`Screen (extra: { order, color, status })` | `ScreenNoteComment (extra: { content })` | Used for changes related to note comments. `project.color` | `created`
`updated`
`deleted` | `Project (extra: { name, platform })` | `Color (extra: { name, r, g, b, a })` | Used for changes related to colors in a project. `project.text_style` | `created`
`updated`
`deleted` | `Project (extra: { name, platform })` | `TextStyle (extra: { name })` | Used for changes related to text styles in a project. `project.component` | `created`
`version_created`
`deleted` | `Project (extra: { name, platform })` | `Component (extra: { name })` | Used for changes related to components in a project. `project.spacing_token` | `created`
`updated`
`deleted` | `Project (extra: { name, platform })` | `SpacingToken (extra: { name, value })` | Used for changes related to spacing tokens in a project. `project.member` | `joined` | `Project (extra: { name, platform })` | | Used for changes related to members of a project. `project.extension` | `added`
`removed` | `Project (extra: { name, platform })` | `Extension (extra: { name })` | Used for changes related to extensions in a project. `project.slack_integration` | `added` | `Project (extra: { name, platform })` | `SlackIntegration (extra: { channel })` | Used for changes related to slack intgrations in a project. `project.jira_attachment` | `added`
`removed` | `Project (extra: { name, platform })` | `JiraIntegration (extra: { issue })` | Used for changes related to jira attachments in a project. `project.screen.jira_attachment` | `added`
`removed` | `Project (extra: { name, platform })`
`Screen (extra: { name })` | `JiraIntegration (extra: { issue })` | Used for changes related to jira attachments in a screen. `project.screen_section.jira_attachment` | `added`
`removed` | `Project (extra: { name, platform })`
`ScreenSection (extra: { name })` | `JiraIntegration (extra: { issue })` | Used for changes related to jira attachments in a screen section. `project.flow_board` | `added` | `Project (extra: { name, platform })` | `FlowBoard (extra: {})` | Used for changes related to flow boards in a project. `styleguide.color` | `created`
`updated`
`deleted` | `Styleguide (extra: { name, platform })` | `Color (extra: { name, r, g, b, a })` | Used for changes related to colors in a styleguide. `styleguide.text_style` | `created`
`updated`
`deleted` | `Styleguide (extra: { name, platform })` | `TextStyle (extra: { name })` | Used for changes related to text styles in a styleguide. `styleguide.component` | `created`
`version_created`
`deleted` | `Styleguide (extra: { name, platform })` | `Component (extra: { name })` | Used for changes related to components in a styleguide. `styleguide.spacing_token` | `created`
`updated`
`deleted` | `Styleguide (extra: { name, platform })` | `SpacingToken (extra: { name, value })` | Used for changes related to spacing tokens in a styleguide. `styleguide.member` | `joined` | `Styleguide (extra: { name, platform })` | `User (extra: { username })` | Used for changes related to members of a styleguide. `styleguide.extension` | `added`
`removed` | `Styleguide (extra: { name, platform })` | `Extension (extra: { name })` | Used for changes related to extensions in a styleguide. `styleguide.slack_integration` | `added` | `Styleguide (extra: { name, platform })` | `SlackIntegration (extra: { channel })` | Used for changes related to slack intgrations in a styleguide. `user.project_membership` | `invited`
`role_updated`
`removed` | - | `Project (extra: { name, platform })` | Used for changes related to notified user's membership to projects. `user.styleguide_membership` | `invited`
`role_updated`
`removed` | - | `Styleguide (extra: { name, platform })` | Used for changes related to notified user's membership to styleguides.

200Successful response: Returns Object Reference

403User cannot create a screen

404Project or screen section not found

422Not a project member or project archived or screen with name already exists