Sign in
Notification

Sends a notification to a specified group of users

Required role: ADMIN

Can filter by:

  • eventId: users following a event
  • role: users that have a role
  • staffShift: staff in a staff shift
  • foodWave: users in a food wave
  • userIds: some set of users Filters are intersecting, so eventId = 123 and foodWave = 1 would get users following event 123 AND in food wave 1.
post/notification/send/

Request

  • Base URL: https://adonix.hackillinois.org
  • URL: https://adonix.hackillinois.org/notification/send/
  • Auth: none declared

Request body

titlestring required
bodystring required
role'ADMIN' | 'STAFF' | 'MENTOR' | 'APPLICANT' | 'ATTENDEE' | 'USER' | 'SPONSOR' | 'BLOBSTORE' | 'PRO'
eventIdstring
staffShiftstring
foodWavenumber
userIdsUserId[]

Example request

{
  "title": "This is a test notification",
  "body": "blame aydan",
  "role": "STAFF"
}

Response

The result of the sent batch

sentUserId[] required
failedUserId[] required
time_msnumber required

Example response

{
  "sent": [
    "github1234"
  ],
  "failed": [
    "github1234"
  ],
  "time_ms": 532
}

Changes

No recorded changes to this operation across all 1 revision of this API.