Skip to content
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.

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

Docs: send notification flow #84

Merged
merged 12 commits into from
Jun 4, 2024
Prev Previous commit
Next Next commit
docs: create erDiagram for the send notification flow
tanhongit committed Jun 3, 2024
commit b7cc6c08aa5d86a8b11748260b8af181ad081228
36 changes: 36 additions & 0 deletions docs/single-flow.md
Original file line number Diff line number Diff line change
@@ -43,3 +43,39 @@ This package is a Laravel wrapper for the `telegram-git-notifier` package. It pr
## Future Work

In the future, additional flows will be implemented to handle other aspects of the bot's functionality, such as error handling, customizing notifications, and sending notifications to multiple users.

```mermaid
erDiagram
User ||--o{ Webhook: sets
Webhook ||--|| Event: triggers
Event ||--o{ Notification: generates
Notification ||--o{ Recipient: sends_to

User {
int id PK
string webhook_url
}

Webhook {
int id PK
string url
}

Event {
int id PK
string name
string action
object payload
}

Notification {
int id PK
string message
}

Recipient {
int id PK
string type "user, group, channel, topic, etc."
string identifier
}
```