Package: bulk-notifications
Generated from api/packages/bulk-notifications
Source: api/packages/bulk-notifications · imported version 0.0.7. The sections after the README are extracted from the code on every docs build.
README
Section titled “README”Bulk-Notifications
Section titled “Bulk-Notifications”API endpoints
Section titled “API endpoints”| Method | Path | Auth | Action |
|---|---|---|---|
POST |
/api/notifications/tokens |
yes | DeviceTokenController@create |
GET |
/api/admin/bulk-notifications |
yes | BulkNotificationController@list |
POST |
/api/admin/bulk-notifications/send |
yes | BulkNotificationController@send |
POST |
/api/admin/bulk-notifications/send/multicast |
yes | BulkNotificationController@sendMulticast |
Permissions
Section titled “Permissions”| Permission | Seeded for roles | Constant |
|---|---|---|
device-token_create |
admin, student, tutor | BulkNotificationPermissionEnum::CREATE_DEVICE_TOKEN |
bulk-notification_create |
admin | BulkNotificationPermissionEnum::CREATE_BULK_NOTIFICATION |
bulk-notification_list |
admin | BulkNotificationPermissionEnum::LIST_BULK_NOTIFICATION |
Settings
Section titled “Settings”Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).
| Key | Rules | Public | Read-only |
|---|---|---|---|
ulams_bulk_notifications.push.service_account |
json | no | |
ulams_bulk_notifications.push.base_redirect_url |
string | no |
Events
Section titled “Events”| Event | Description | Notification templates |
|---|---|---|
NotificationSent |
Artisan commands
Section titled “Artisan commands”None.
Scheduled jobs
Section titled “Scheduled jobs”None.
Environment variables read
Section titled “Environment variables read”None.