Notifications
Flow can send various kinds of alerts of updates to users.
The Notification Model
A notification is an alert of some kind sent to the user. Its attributes are:
- Name
category- Type
- int
- Description
What the notification is there to convey.
- Name
created- Type
- int
- Description
The timestamp for when the notification was generated.
- Name
has_read- Type
- bool
- Description
Whether the notification has been seen by the user.
- Name
resolved- Type
- bool
- Description
Ssome notifications require an action of some kind from the user (such as accepting an invitation) - when this is true, it means the user has responded.
- Name
recipient- Type
- ID
- Description
The user receiving the notification
- Name
text- Type
- str
- Description
A string associated with the notification.
- Name
user- Type
- ID
- Description
A user object associated with the notification (the meaning of which will depend on the notification category).
- Name
group- Type
- ID
- Description
A group object associated with the notification (the meaning of which will depend on the notification category).
- Name
project- Type
- ID
- Description
A project object associated with the notification (the meaning of which will depend on the notification category).
- Name
sample- Type
- ID
- Description
A sample object associated with the notification (the meaning of which will depend on the notification category).
- Name
execution- Type
- ID
- Description
A execution object associated with the notification (the meaning of which will depend on the notification category).
- Name
data- Type
- ID
- Description
A data object associated with the notification (the meaning of which will depend on the notification category).
The categories are as follows:
- the user has been invited to a group.
- the user's group invite has been accepted by the user it was sent to.
- the user's group invite has been declined by the user it was sent to.
- the user has been made an admin of a group.
- the user's admin status has been revoked for a group.
- the user has been removed from a group.
- a group the user belongs to has been deleted.
- the user's group has received an object.
- the user has received an object.
You cannot specifically create a notification via the API (they are generated incidentally by other actions) but you can query them, mark them as read etc.
News
A news item is a general update that gets displayed on the home page. Its atttibutes are:
- Name
category- Type
- int
- Description
The type of news - 1 is an update about pipelines, 2 is an update about features, 3 is an update about any other news.
- Name
date- Type
- date
- Description
The date the news item is released.
- Name
headline- Type
- string
- Description
The summary of the news.
- Name
text- Type
- string
- Description
The plain text of the news.
Emails
Certain events trigger an email to be sent to the user:
- When they sign up, they receive a welcome email.
- When they request a password reset, the link to do so is sent via an email.
- If a password reset email is sent to an email not associated with an account, that email address receives an email alerting them of this.