Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wxyShine/plugin-webhook
Halo插件，为Halo提供Webhook支持
https://github.com/wxyShine/plugin-webhook
Last synced: about 1 month ago
JSON representation
Halo插件，为Halo提供Webhook支持
- Host: GitHub
- URL: https://github.com/wxyShine/plugin-webhook
- Owner: wxyShine
- License: gpl-3.0
- Created: 2024-04-24T13:07:35.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-11T03:57:38.000Z (7 months ago)
- Last Synced: 2024-08-02T06:17:35.885Z (4 months ago)
- Language: Java
- Homepage: https://www.wxy97.com/archives/2135a7d6-e40a-4bae-b4a6-06db588b97aa
- Size: 165 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-halo - plugin-webhook - 为 Halo 2.0 提供 Webhook 支持，该插件允许用户在特定事件发生时（如文章发布、新评论、回复评论等事件）发送通知到指定的 Webhook URL。 (Halo 2.0 / 插件)
README
# plugin-webhook
## 🎟️简介
`plugin-webhook` 是一个为 [Halo](https://halo.run/) （强大易用的开源建站工具）设计的Webhook插件。
Webhook 是一种通过 HTTP 协议实现的回调机制，允许用户在特定事件发生时（如文章发布、新评论、回复评论等事件）将数据推送到指定的 Webhook URL。这种机制使得用户可以实时地将事件通知发送到外部系统，从而实现与其他服务的集成。
> 点击测试时 如果你配置的Webhook URL 无误将会收到一条如下数据:
```json
{
"eventType": "TEST_WEBHOOK",
"eventTypeName": "测试webhook",
"hookTime": "2024-04-24 16:16:51",
"data": "Test webhook success"
}
```
> 更多事件详细说明请参考[使用文档](https://www.wxy97.com/archives/2135a7d6-e40a-4bae-b4a6-06db588b97aa)
## ✨功能
- **事件触发**：当在Halo中发生特定事件（如文章发布、新评论、回复评论等事件）时，触发Webhook调用。
- **灵活配置**：用户可以配置Webhook URL
- **简单集成**：易于在现有的Halo博客系统中集成和使用。
## 💻安装
如何安装和配置`plugin-webhook`插件。
### 1. 下载，目前提供以下下载方式：
GitHub Releases：访问 [Releases](https://github.com/wxyShine/plugin-webhook/releases) 下载 Assets 中的 JAR 文件。
安装，插件安装和更新方式可[参考](https://docs.halo.run/user-guide/plugins)
安装完成之后，记得启用插件并完成相关配置。
### 2. 应用商店安装
[Halo应用商店](https://www.halo.run/store/apps/app-sCQyp)
## 📒[TODO](https://github.com/wxyShine/plugin-webhook)
- [x] TEST_WEBHOOK("测试webhook")
- [x] NEW_POST("发布文章")
- [x] DELETE_POST("删除文章")
- [x] NEW_COMMENT("发表评论")
- [x] DELETE_COMMENT("删除评论")
- [x] REPLY_COMMENT("回复评论")
- [x] DELETE_REPLY_COMMENT("删除回复")
- [ ] 发布瞬间
- [ ] 删除瞬间
- [ ] 可配置事件
...
## ✍️贡献
如果您有兴趣为plugin-webhook贡献代码或文档，欢迎Fork本仓库并提交[Pull Request](https://github.com/wxyShine/plugin-webhook/pulls)。
## ⛓️支持
如果您在使用halo-plugin-webhook时遇到任何问题，可以通过以下方式寻求帮助：
提交[GitHub Issue](https://github.com/wxyShine/plugin-webhook/issues)。