Skip to content

Scissor grinder cicada #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Scissor grinder cicada #158

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1865ccc
Add scissor grinder cicada
ckaipf Nov 5, 2025
3235bfc
Fix spelling and formatting
ckaipf Nov 5, 2025
8253446
Rename SMS parameters for consistency
ckaipf Nov 7, 2025
f157007
Update 81-scissor-grinder-cicada/technical_specification.md
ckaipf Nov 13, 2025
9b573bc
Update config parameter names
ckaipf Nov 17, 2025
ab5c2f1
Add note about the renaming of the event Notification
ckaipf Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions 81-scissor-grinder-cicada/technical_specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Notification Service Update (Scissor Grinder Cicada)
**Epic Type:** Implementation Epic

## Scope
This epic will add an SMS channel to the Notification Service to enable SMS delivery.
It will include:
- Schema definition for an SMS notification event
- Adding the schema to `ghga-event-schemas`
- Functionality for consuming those events and dispatching notifications via an SMS gateway

It does not include:
- Changing existing services to send SMS notification events
- Updating the Notification Orchestration Service to emit SMS notification events

## Additional Implementation Details

### SMS Notification Event
An SMS notification event schema will be defined in the `ghga-event-schemas` repository.
The event schema will detail all the information needed to send a notification via SMS:
- `text` (required)
- `phone` (required)

The exact field names and constraints will be provided in the `ghga-event-schemas` repository, which is considered the source of truth.
This information will be used to create an SMS with a consistent format.

### Email Notification Event
The notification event `Notification` will be renamed to `EmailNotification` for clarity.


### Notification Service
This is a microservice dedicated to consuming notification events from the "notifications" topic in Kafka.
In this update, a new type of notification event will be added to expand the service's capabilities.

To utilize the Notification Service to send SMS, publishers will need to publish an event to the "notifications" topic using the "SMS notification" event type, with a payload conforming to the schema defined by `SmsNotification` in the `ghga-event-schemas` repository.

SMS will be sent via HTTP, and SMS contents will be injected into the requests. The parameters required to successfully configure the service are as follows:
- `lox24_host`: The address of the SMS gateway
- `lox24_port`: The port to use
- `lox24_token`: The API token used for authentication and authorization
- `lox24_sender_id`: The sender's ID or phone number
- `lox24_auth_token_header`: The header used for the API token
- `lox24_timeout`: The timeout used for the requests
- `lox24_sms_send_path`: The API path to send SMS

## Human Resource/Time Estimation

- Number of sprints required: 1
- Number of developers required: 1