darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-04 02:11:11 -05:00
Code Issues Packages Projects Releases Wiki Activity

Small doc updates (#253)

Browse Source
This commit is contained in:
Steven Reilly
2023-05-02 10:25:02 -04:00
committed by GitHub
parent d887394682
commit 881f479417
2 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/message-sending-path.md Normal file
View File

@@ -0,0 +1,15 @@
# How messages are queued and sent
There are several ways for notifications to come into the API.
- Messages sent through the API enter through `app/notifications/post_notifications.py`
- One-off messages sent from the UI enter through `create_one_off_notification` in `app/service/rest.py`
- CSV uploads enter through `app/job/rest.py`
API messages and one-off UI messages come in one at a time, and take slightly-separate routes
that both end up at `persist_notification`, which writes to the database, and `provider_tasks.deliver_sms`,
which enqueues the sending.
For CSV uploads, the CSV is first stored in S3 and queued as a `Job`. When the job runs, it iterates
through the rows, running `process_job.save_sms` to send notifications through `persist_notification` and
`provider_tasks.deliver_sms`.