You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+78Lines changed: 78 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,84 @@ Hooks is a RESTful webhook server framework written in Ruby. It is designed to b
26
26
27
27
Hooks is designed to be very easy to setup and use. It provides a simple DSL for defining webhook endpoints and then you can use plugins to handle the incoming requests and optionally authenticate them.
28
28
29
+
### Architecture Flow
30
+
31
+
The following Mermaid diagram shows the complete request processing flow, including server bootstrap, plugin loading, and webhook request handling:
Here is a very high-level overview of how Hooks works:
30
108
31
109
1. You define a global configuration file (e.g. `hooks.yml`) where you can specify where your webhook endpoint configs are located, and the directory where your plugins are located. Here is an example of a minimal configuration file:
0 commit comments