The notification entity holds information about which user should have received a notification and what contents this notification has. Also, the seen and read information for a notification is stored in this table.
Notifications are related to many different entities as polymorphic relations which intratool will resolve by given keys.
An internal notification basically consists of:
Type
Target entity
Notifiable entity
to resolve which type of information should be dispatched to whom.
Model Definition
Relations
Relation
Key
Type
Relation Field(s)
Targetable (see below)
notifiable
Morph to
notifiable_type, notifiable_id
Notifiable (see below)
targetable
Morph to
targetable_type, targetable_id
Targetable types
infoboardPost ()
infoboardComment ()
calendarEvent (not documented yet).
ManualEntry ()
Notifiable types
Types
infoboardPostCreated
infoboardPostUpdated
infoboardCommentCreated
calendarEventCreated
calendarEventUpdated
ManualEntryCreated
ManualEntryUpdated
generic
Targetable types are keys for different entities existing in our system. Every targetable type listed here has itself a relationship to notifications which can be accessed with the key notifications.
Affected entities are marked with the trait TriggersNotifications.
Lists all Notifications with the given target entity type and target entity ID. This enables you to get all notifications related to a specific content.
{
"id": "3dbac57e-d7a5-43b6-ab7b-8999f3a209d9",
"type": "calendarEventCreated",
"notifiable_type": "user",
"notifiable_id": 1,
"targetable_type": "calendarEvent",
"targetable_id": 16,
"data": {
"title": "Neuer Termin im Kalender von Max Mustermann",
"body": "Example body",
"url": "/kalender/#event=6voprwjq5x3w83n9y2k740e8"
},
"seen_at": null,
"read_at": null,
"created_at": "2019-05-10 11:34:57",
"updated_at": "2019-05-10 11:34:57"
}
Create
Create a new Notification.
This will dispatch a generic notification based on given information to all clients within the given departments and / or users and should be used with care.
Definition
POST/api/notifications
Request Keys
Key
Type
Default
Description
title *
string
-
The title of the notification.
body*
string
-
The body text of the notification.
url *
string
-
The url the dispatched notification should point to.
department_ids
array
The array of departments that should be targeted by the notification.
user_ids
array
-
The array of users that should be targeted by the notification.
The fields with * are required.
Advanced Key-Specifications
department_ids - The array needs to contain valid department ids as integers.
user_ids - The array needs to contain valid user ids as integers.
user_ids - Needs to be filled if there are no department_ids
Example Request
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/notifications', [
'headers' => ['Authorization' => "Bearer {accessToken}"],
'json' => [
'title' => 'My own notification',
'body' => 'The body of my notification.',
'url' => 'https://my-internal-system.de/',
'department_ids' => [3,4,5],
'user_ids' => [4, 6, 8, 10]
]
]);
Example Response
{
"status": "success",
"data": []
}
Update for user
Update all unread notifications for the current authenticated user. This route will return the count of affected rows on success.
Notifications are dispatched by our system when you save the information. Thus given, you can not update any content of notifications that are already dispatched.
Definition
PUT/api/notifications/
Request Keys
Key
Type
Default
Description
seen_at *
datetime
NULL
The timestamp when a user has seen the notification.
read_at*
datetime
NULL
The timestamp when a user has read the notification.
The fields with * are required.
Advanced Key-Specifications
read_at - This value will also set the seen_at information if no value is given for seen_at
Update a unread notification of the current authenticated user by it's target. This is useful if you want to update a notification related to a specific content.
