docs

README.md

@@ -11,4 +11,52 @@ pinned: false
 
 ## Spaces CI webhook
 
-This is a webhook space to build temporary Spaces when a PR is submitted.
+This is a webhook space to build temporary Spaces when a PR is submitted.
+
+## gradio_webhooks
+
+This is also a PoC for a `gradio_webhooks` helper library. It uses Gradio to launch a server and register webhooks on it.
+
+The major goal is to make the development process as easy as possible:
+- debug your webhooks locally using a Gradio URL
+- push your webhook server to a Gradio Space once ready
+
+Features:
+- Server app with `GradioWebhookApp`
+- Debug locally before deploying on Spaces
+- Handle `x-webhook-secret` header
+- Output is parsed as `WebhookPayload` (to be completed)
+
+### Quick example:
+
+**app.py**
+
+```py
+from gradio_webhooks import GradioWebhookApp, WebhookPayload
+
+app = GradioWebhookApp(webhook_secret="my_dummy_secret")
+
+
+@app.add_webhook("/my_webhook")
+async def hello(payload: WebhookPayload):
+    print(f"Received webhook for repo {payload.repo.name}")
+    return {"processed": True}
+
+
+app.ready()
+```
+
+**Output in terminal**
+
+```text
+Running on local URL:  http://127.0.0.1:7860
+Running on public URL: https://18ffc05a-d0bf-4041.gradio.live
+
+This share link expires in 72 hours. For free permanent hosting and GPU upgrades (NEW!), check out Spaces: https://huggingface.co/spaces
+
+Webhook secret is correctly defined.
+
+Webhooks are correctly setup and ready to use:
+  - POST https://18ffc05a-d0bf-4041.gradio.live/my_webhook
+Go to https://huggingface.co/settings/webhooks to setup your webhooks.
+```

gradio_webhooks.py

@@ -80,7 +80,7 @@ class GradioWebhookApp:
         ).strip("/")
         print("\nWebhooks are correctly setup and ready to use:")
         print("\n".join(f"  - POST {url}{webhook}" for webhook in self.webhook_paths))
-        print(f"Checkout {url}/docs for more details.")
+        print("Go to https://huggingface.co/settings/webhooks to setup your webhooks.")
         self.gradio_app.block_thread()
 
     async def _webhook_secret_middleware(self, request: Request, call_next) -> None: